diff options
author | Todd Gamblin <gamblin2@llnl.gov> | 2022-12-22 02:50:48 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-22 11:50:48 +0100 |
commit | 8f3f838763db33782db743d1bef44d7e550db6f8 (patch) | |
tree | 14e528f2f94f9537760e02fb6b784d01acccc162 /.github/workflows/unit_tests.yaml | |
parent | 09864d00c586e0a3cb069e4b1eeee898dd165cb2 (diff) | |
download | spack-8f3f838763db33782db743d1bef44d7e550db6f8.tar.gz spack-8f3f838763db33782db743d1bef44d7e550db6f8.tar.bz2 spack-8f3f838763db33782db743d1bef44d7e550db6f8.tar.xz spack-8f3f838763db33782db743d1bef44d7e550db6f8.zip |
docs: show module documentation before submodules (#34258)
Currently, the Spack docs show documentation for submodules *before* documentation for
submodules on package doc pages. This means that if you put docs in `__init__.py` in
some package, the docs in there will be shown *after* the docs for all submodules of the
package instead of at the top as an intro to the package. See, e.g.,
[the lockfile docs](https://spack.readthedocs.io/en/latest/spack.environment.html#module-spack.environment),
which should be at the
[top of that page](https://spack.readthedocs.io/en/latest/spack.environment.html).
- [x] add the `--module-first` option to sphinx so that it generates module docs at top of page.
Diffstat (limited to '.github/workflows/unit_tests.yaml')
0 files changed, 0 insertions, 0 deletions