Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-14782: Replace astropy_helpers with sphinx-automodapi and improve Sphinx configurations for stack documentation #36

Merged
merged 10 commits into from
Jun 29, 2018
Merged

DM-14782: Replace astropy_helpers with sphinx-automodapi and improve Sphinx configurations for stack documentation #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4b98b0e
Add pdb attribute to MockSphinxNamespace
jonathansick Jun 14, 2018
622c8e1
Update run_sphinx for Sphinx 1.7
jonathansick Jun 14, 2018
0d944bc
Refactor stackconfig by topic
jonathansick Jun 14, 2018
f1b3b63
Remove h5py from stackconfig intersphinx mapping
jonathansick Jun 14, 2018
d3aa241
Replace astropy_helpers with numpydoc/ automodapi
jonathansick Jun 14, 2018
27f8424
Remove viewcode extension from stackconf
jonathansick Jun 14, 2018
cd0e007
Update configs for automodapi / autodoc
jonathansick Jun 14, 2018
f1a2a65
Update intersphinx URLs
jonathansick Jun 15, 2018
3ac2814
Add build_pipelines_lsst_io_configs
jonathansick Jun 15, 2018
efba06f
Update changelog with stackconf improvements
jonathansick Jun 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,23 @@ Unreleased
- Refactored the Sphinx interface into ``documenteer.sphinxrunner.run_sphinx``.
This change lets multiple command-line front-ends to drive Sphinx.

- Various improvements to the configuration for LSST Stack-based documentation projects (``documenteer.sphinxconf.stackconf``):

- Add ``documenteer.sphinxconf.stackconf.build_pipelines_lsst_io_configs`` to configure the Sphinx build of the https://github.com/lsst/pipelines_lsst_io repo.
This pattern lets us share configurations between per-package documentation builds and the "stack" build in ``pipelines_lsst_io``.

- Replaced the third-party `astropy_helpers`_ package with the numpydoc_ and `sphinx-automodapi`_ packages.
This helps reduce the number of extraneous dependencies needed for Stack documentation.

- ``autoclass_content`` is now ``"class"``, fitting the LSST DM standards for writing class docstrings, and not filling out ``__init__`` docstrings.

- Removed h5py from intersphinx since it was never needed.

- Removed the viewcode extension since that won't scale well with the LSST codebase.
Ultimately we want to link to source on GitHub.

- Other internal cleanups for ``documenteer.sphinxconf.stackconf``.

- Recognize a new field in the ``metadata.yaml`` files of Sphinx technotes called ``exclude_patterns``.
This is an array of file or directory paths that will be ignored by Sphinx during its build, as well as extensions like our ``get_project_content_commit_date`` for looking up commit date of content files.

Expand Down Expand Up @@ -169,3 +186,6 @@ Includes prototype support for LSST Science Pipelines documentation, as part of
- Initial version

.. _lsst-texmf: https://github.com/lsst/lsst-texmf
.. _astropy_helpers: https://pypi.org/project/astropy-helpers/
.. _`sphinx-automodapi`: https://pypi.org/project/sphinx-automodapi/
.. _numpydoc: https://pypi.org/project/numpydoc/
Loading