DM-11004: Update based on build-stack-docs tool implementation #3
Conversation
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
manifest.yaml and the idea of separating module and package documentation types came up during development of the build-stack-docs tool in documenteer. Declaring documentation layout in manifest.yaml makes it easier to build the integration documentation.
Making package documentation (documentation at the level of a Git repository) separate from documentation about the Python module is a good thing. This commit reflects the introduction of the package topic type.
| .. | ||
|
|
||
| Module documentation directories are symlinked into pipelines_lsst_io_\ ’s ``modules/`` directory. | ||
| Likewise, package documentation directories are symlinked into pipelines_lsst_io_\ ’s ``packages/`` directory. With all documentation content directories linked into the pipelines_lsst_io_ directory, Sphinx is able to build the LSST Science Pipelines documentation if it were a unified project. |
There was a problem hiding this comment.
Extra space between linked and into.
documentation if --> documentation as if
| - EUPS dependencies (computed both downstream and upstream). | ||
|
|
||
| Most documentation provided by a package is included in :ref:`module topics <module-type>`. | ||
| The package topic type, though, provides a documentation platform the package itself. |
There was a problem hiding this comment.
platform the --> platform for the
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the documentation design based on implementation developments with the build tool (see also lsst-sqre/documenteer#14).
doc/manifest.yamlfile that declares what documentation directories are included in a package and helps to create links.See https://dmtn-030.lsst.io/v/DM-11004