-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #60 from lsst/tickets/DM-15815
Convert daf_base to numpydoc status
- Loading branch information
Showing
12 changed files
with
167 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Doxygen products | ||
html | ||
xml | ||
*.tag | ||
*.inc | ||
doxygen.conf | ||
|
||
# Sphinx products | ||
_build | ||
py-api |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
"""Sphinx configuration file for an LSST stack package. | ||
This configuration only affects single-package Sphinx documentation builds. | ||
""" | ||
|
||
from documenteer.sphinxconfig.stackconf import build_package_configs | ||
import lsst.daf.base | ||
|
||
|
||
_g = globals() | ||
_g.update(build_package_configs( | ||
project_name='daf_base', | ||
version=lsst.daf.base.version.__version__)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
############################## | ||
daf_base documentation preview | ||
############################## | ||
|
||
.. This page is for local development only. It isn't published to pipelines.lsst.io. | ||
.. Link the index pages of package and module documentation directions (listed in manifest.yaml). | ||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
lsst.daf.base/index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
.. py:currentmodule:: lsst.daf.base | ||
.. _lsst.daf.base: | ||
|
||
############# | ||
lsst.daf.base | ||
############# | ||
|
||
.. Paragraph that describes what this Python module does and links to related modules and frameworks. | ||
.. .. _lsst.daf.base-using: | ||
.. Using lsst.daf.base | ||
.. ================== | ||
.. toctree linking to topics related to using the module's APIs. | ||
.. .. toctree:: | ||
.. :maxdepth: 1 | ||
.. _lsst.daf.base-contributing: | ||
|
||
Contributing | ||
============ | ||
|
||
``lsst.daf.base`` is developed at https://github.com/lsst/daf_base. | ||
You can find Jira issues for this module under the `daf_base <https://jira.lsstcorp.org/issues/?jql=project%20%3D%20DM%20AND%20component%20%3D%20daf_base>`_ component. | ||
|
||
.. _lsst.daf.base-pyapi: | ||
|
||
Python API reference | ||
==================== | ||
|
||
.. automodapi:: lsst.daf.base | ||
:no-main-docstr: | ||
:no-inheritance-diagram: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Documentation manifest. | ||
|
||
# List of names of Python modules in this package. | ||
# For each module there is a corresponding module doc subdirectory. | ||
modules: | ||
- "lsst.daf.base" | ||
|
||
# Name of the static content directories (subdirectories of `_static`). | ||
# Static content directories are usually named after the package. | ||
# Most packages do not need a static content directory (leave commented out). | ||
# statics: | ||
# - "_static/example" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters