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

Jump to bottom

DM-41296: Migrate out of documenteer.sphinxext namespace #193

Merged
merged 8 commits into from
Oct 26, 2023
Merged

DM-41296: Migrate out of documenteer.sphinxext namespace #193

merged 8 commits into from
Oct 26, 2023

Commits on Oct 26, 2023

  1. Migrate out of documenteer.sphinxext namespace 

    - Migrate the bibtex, jira, lsstdocushare, mockcoderefs, packagetoctree
  and lssttasks Sphinx extensions for documenteer.sphinxext to
  documenteer.ext, where all new extensions are being added.

- Drop the original documenteer.sphinxconfig package; all Pipelines
  configurations are now done through the documenteer.conf.pipelines
  configuration module.
    @jonathansick
    jonathansick committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    85edf1a View commit details
    Browse the repository at this point in the history

  2. Add sphinx-jinja to guides configuration 

    This ensures that all guides automatically include the sphinx-jinja
dependency. They will need to configure their context in their own
conf.py files, though.
    @jonathansick
    jonathansick committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    a55d5a0 View commit details
    Browse the repository at this point in the history

  3. Merge pipelines configuration with guide config 

    Now documenteer.conf.pipelines imports its base configuration from
documenteer.conf.guide. This allows us to retire the original theme,
lsst-sphinx-bootstrap-theme. It'll also help us unify the pipelines
documentation with the overall engineering and support we have for Rubin
guides in general.

The pipelines configuration add additional extensions. It still makes
sense to ship this as a configuration through documenteer because
individual packages will use documenteer.conf.pipelinespkg to do single
package documentation previews.

Since the guides configuration uses documenteer.toml, it might make
sense to migrate manifest.yaml into documenteer.toml as a separate
table.
    @jonathansick
    jonathansick committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    0eadda1 View commit details
    Browse the repository at this point in the history

  4. Delete the refresh-lsst-bib CLI 

    This CLI was developed for the original technotes to vendor bibtex files
from lsst/lsst-texmf. Documenteer's technotes now download and cache bib
files automatically.
    @jonathansick
    jonathansick committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    f6011f6 View commit details
    Browse the repository at this point in the history

  5. Delete the build-stack-docs CLI 

    This CLI was the predecessor for stack-docs. It should be fully
deprecated at this point.
    @jonathansick
    jonathansick committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    9f2a732 View commit details
    Browse the repository at this point in the history

  6. Add change log file

    @jonathansick
    jonathansick committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    ab9c923 View commit details
    Browse the repository at this point in the history

  7. Add sphinx-rediraffe to the guides configuration 

    This makes it convenient to create redirect pages when documentation is
moved or renamed.

https://sphinxext-rediraffe.readthedocs.io/en/latest/
    @jonathansick
    jonathansick committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    d820728 View commit details
    Browse the repository at this point in the history

  8. Move /pipelines docs to /guides/pipelines 

    This is the initial move with rediraffe redirects. More work is needed
to make the content reflect the new relationship between guides and the
specific pipelines docs use case.
    @jonathansick
    jonathansick committed Oct 26, 2023
    Configuration menu
    Copy the full SHA
    cde778d View commit details
    Browse the repository at this point in the history