Documentation upgrade and XST documented

AlanLoh · Jun 20, 2024 · e284303 · e284303
1 parent 278f8ba
commit e284303
Show file tree

Hide file tree

Showing 396 changed files with 6,967 additions and 2,660 deletions.
diff --git a/Logo-NenuFAR-noir.svg b/Logo-NenuFAR-noir.svg
diff --git a/docs/Makefile b/docs/Makefile
@@ -3,24 +3,24 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SOURCEDIR     = .
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+# .PHONY: help Makefile
 
 #html:
 #   $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 
-rst:
-	sphinx-apidoc -o . ../nenupy --force --separate --implicit-namespaces --templatedir ./_templates
+# rst:
+# 	sphinx-apidoc -o . ../nenupy --force --separate --implicit-namespaces --templatedir ./_templates
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile rst
+%: Makefile# rst
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/io/xst_reading.rst b/docs/io/xst_reading.rst
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,28 @@
+
+ @ECHO OFF
+pushd %~dp0
+REM Command file for Sphinx documentation
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=_build
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+if "%1" == "" goto help
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+:end
+popd
diff --git a/docs/modules.rst b/docs/modules.rst
diff --git a/docs/nenupy.astro.astro_tools.rst b/docs/nenupy.astro.astro_tools.rst
diff --git a/docs/nenupy.astro.beam_correction.rst b/docs/nenupy.astro.beam_correction.rst
diff --git a/docs/nenupy.astro.jones_mueller.rst b/docs/nenupy.astro.jones_mueller.rst
diff --git a/docs/nenupy.astro.pointing.rst b/docs/nenupy.astro.pointing.rst
diff --git a/docs/nenupy.astro.sky.rst b/docs/nenupy.astro.sky.rst
diff --git a/docs/nenupy.astro.skymodel.rst b/docs/nenupy.astro.skymodel.rst
diff --git a/docs/nenupy.astro.target.rst b/docs/nenupy.astro.target.rst
diff --git a/docs/nenupy.astro.uvw.rst b/docs/nenupy.astro.uvw.rst
diff --git a/docs/nenupy.beamlet.beamlet.rst b/docs/nenupy.beamlet.beamlet.rst
diff --git a/docs/nenupy.beamlet.bstdata.rst b/docs/nenupy.beamlet.bstdata.rst