Basic documentation

sdss · Nov 23, 2023 · 9367ce6 · 9367ce6
1 parent 3aee8d7
commit 9367ce6
Show file tree

Hide file tree

Showing 18 changed files with 162 additions and 904 deletions.
diff --git a/docs/sphinx/actor-schema.rst b/docs/sphinx/actor-schema.rst
diff --git a/docs/sphinx/actor.rst b/docs/sphinx/actor.rst
diff --git a/docs/sphinx/api.rst b/docs/sphinx/api.rst
@@ -0,0 +1,25 @@
+.. _lvmnps-api:
+
+API
+===
+
+Base client
+-----------
+
+.. autoclass:: lvmnps.nps.core.NPSClient
+   :members:
+   :show-inheritance:
+
+.. autopydantic_model:: lvmnps.nps.core.OutletModel
+   :model-show-json: false
+   :exclude-members: model_post_init
+
+
+Implementations
+---------------
+
+.. autoclass:: lvmnps.nps.implementations.dli.DLIClient
+
+.. autopydantic_model:: lvmnps.nps.implementations.dli.DLIOutletModel
+   :model-show-json: false
+   :exclude-members: model_post_init
diff --git a/docs/sphinx/commands.rst b/docs/sphinx/commands.rst
@@ -5,6 +5,6 @@ Commands
 
 The ``lvmnps`` actor replies to the follwing commands.
 
-.. click:: lvmnps.actor.commands:parser
+.. click:: lvmnps.actor.commands:lvmnps_command_parser
   :prog: lvmnps
   :show-nested:
diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
@@ -13,13 +13,7 @@
 
 from pkg_resources import parse_version
 
-
-try:
-    from lvmnps import __version__
-except ModuleNotFoundError:
-    from sdsstools import get_package_version
-
-    __version__ = get_package_version(__file__, "sdss-lvmnps") or "dev"
+from lvmnps import __version__
 
 
 # Are we building in RTD?
@@ -51,20 +45,25 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx.ext.autosummary",
+    "sphinx_autodoc_typehints",
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx.ext.mathjax",
     "sphinx.ext.intersphinx",
     "sphinx.ext.inheritance_diagram",
     "myst_parser",
     "sphinx_copybutton",
-    "sphinx_click",
+    "sphinx_click.ext",
     "sphinx-jsonschema",
+    "sphinxcontrib.autodoc_pydantic",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
+pygments_style = "lovelace"
+pygments_dark_style = "one-dark"
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
@@ -80,8 +79,8 @@
 
 # General information about the project.
 project = "lvmnps"
-copyright = "{0}, {1}".format("2021", "SDSS LVMI softwareteam in Kyung Hee university")
-author = "Mingyeong Yang"
+copyright = "{0}, {1}".format("2021-", "Sloan Digital Sky Survey")
+author = "Mingyeong Yang and others"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -97,7 +96,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -133,27 +132,24 @@
 
 # Intersphinx mappings
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.6", None),
-    "astropy": ("http://docs.astropy.org/en/latest", None),
-    "numpy": ("http://docs.scipy.org/doc/numpy/", None),
-    "click": ("https://click.palletsprojects.com/en/7.x/", None),
-    "aio_pika": ("https://aio-pika.readthedocs.io/en/latest/", None),
+    "python": ("https://docs.python.org/3.12", None),
 }
 
 autodoc_mock_imports = ["_tkinter", "asynctest", "numpy", "pymodbus"]
 autodoc_member_order = "groupwise"
 autodoc_default_options = {"members": None, "show-inheritance": None}
-autodoc_typehints = "description"
+# autodoc_typehints = "description"
 
-napoleon_use_rtype = False
-napoleon_use_ivar = True
+# napoleon_use_rtype = False
+# napoleon_use_ivar = True
+
+simplify_optional_unions = True
+typehints_use_signature_return = True
 
 copybutton_prompt_text = r">>> |\$ "
 copybutton_prompt_is_regexp = True
 
 rst_epilog = f"""
-.. |numpy_array| replace:: Numpy array
-.. |HDUList| replace:: :class:`~astropy.io.fits.HDUList`
 .. |npsactor_version| replace:: {__version__}
 """
 
@@ -166,8 +162,13 @@
 
 html_theme = "furo"
 html_logo = "_static/sdssv_logo.png"
-html_title = "lvmnps"
+html_title = "lvmnps documentation"
 html_favicon = "./_static/favicon.ico"
+html_theme_options = {
+    "source_repository": "https://github.com/sdss/lvmnps/",
+    "source_branch": "main",
+    "source_directory": "docs/sphinx",
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/sphinx/developer-env.rst b/docs/sphinx/developer-env.rst