Update doc

AlanLoh · Jun 11, 2024 · f62c3aa · f62c3aa
1 parent ea8cfaa
commit f62c3aa
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 17 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -88,20 +88,20 @@
 
 
 # Napoleon settings
-# napoleon_google_docstring = True
-# napoleon_numpy_docstring = True
-# napoleon_include_init_with_doc = False
-# napoleon_include_private_with_doc = False
-# napoleon_include_special_with_doc = True
-# napoleon_use_admonition_for_examples = False
-# napoleon_use_admonition_for_notes = False
-# napoleon_use_admonition_for_references = False
-# napoleon_use_ivar = False
-# napoleon_use_param = False
-# napoleon_use_rtype = False
-# napoleon_preprocess_types = False
-# napoleon_type_aliases = None
-# napoleon_attr_annotations = True
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = False
+napoleon_use_rtype = False
+napoleon_preprocess_types = False
+napoleon_type_aliases = None
+napoleon_attr_annotations = True
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -122,7 +122,7 @@ Finally, observations can then be simulated using the simulated beam and a sky m
 
 .. toctree::
    :caption: Modules
-   :maxdepth: 2
+   :maxdepth: 3
 
    nenupy.astro
    nenupy.io

diff --git a/docs/install.rst b/docs/install.rst
@@ -6,7 +6,15 @@ Installing with pip
 
 These instructions cover installation with the Python package
 management tool `PyPI <https://pypi.org/project/nenupytf/>`_.
-``Python3.7`` or higher is required and no support will be provided for ``Python2``.
+``Python3.8`` or higher is required and no support will be provided for ``Python2``.
+
+The latest version can be installed directly grom github:
+
+.. code-block:: bash
+
+   $ pip install --upgrade https://github.com/AlanLoh/nenupy/tarball/master
+
+To get the latest release (may be lacking the latest features):
 
 .. code-block:: bash
 

diff --git a/docs/instru/array_configuration.rst b/docs/instru/array_configuration.rst
@@ -3,7 +3,7 @@
 Array Configuration
 ===================
 
-The `NenuFAR <https://nenufar.obs-nancay.fr/en/homepage-en/>`_ low-frequency radio telescope can de viewed as a hierarchy of elements (i.e., the individual dipole antennas, the mini-arrays and the whole array).
+The `NenuFAR <https://nenufar.obs-nancay.fr/en/homepage-en/>`_ low-frequency radio telescope can be viewed as a hierarchy of elements (i.e., the individual dipole antennas, the mini-arrays and the whole array).
 In order to better capture these configurations, the associated parameters, while aiming at delivering the related physical properties, ``nenupy`` offers two main classes to represent this complexity: :class:`~nenupy.instru.nenufar.MiniArray` and :class:`~nenupy.instru.nenufar.NenuFAR`.
 
 Both of these classes inherit from the base class :class:`~nenupy.instru.interferometer.Interferometer`, which is an abstract Python class.

diff --git a/docs/nenupy.schedule.open_time.rst b/docs/nenupy.schedule.open_time.rst
@@ -0,0 +1,7 @@
+ nenupy.schedule.open\_time
+===========================
+
+.. automodule:: nenupy.schedule.open_time
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/nenupy.schedule.rst b/docs/nenupy.schedule.rst
@@ -9,6 +9,7 @@ nenupy.schedule
    nenupy.schedule.contamination
    nenupy.schedule.geneticalgo
    nenupy.schedule.obsblocks
+   nenupy.schedule.open_time
    nenupy.schedule.schedule
    nenupy.schedule.targets