Skip to content

Commit

Permalink
DOC: Update the infrastructure guide
Browse files Browse the repository at this point in the history
Include informaton about the workflow managing versions on gh-pages.
  • Loading branch information
dopplershift committed Apr 28, 2021
1 parent af59eef commit e995194
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/devel/infrastructureguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,13 @@ extension also makes these scripts available as Jupyter notebooks.
The documentation is hosted on `GitHub Pages <https://unidata.github.io/MetPy>`_. The docs are
built automatically and uploaded upon pushes or merges to GitHub. Commits to ``main`` end up
in our development version docs, while commits to versioned branches will update the
docs for the corresponding version, which are located in the appropriately named subidrectory
docs for the corresponding version, which are located in the appropriately named subdirectory
on the ``gh-pages`` branch. We only maintain docs at the minor level, not the bugfix one.
The docs rely on the ``pydata-sphinx-theme`` package for styling the docs, which needs to be
installed for any local doc builds.
installed for any local doc builds. The ``gh-pages`` branch has a GitHub Actions workflow that
handles generating a ``versions.json`` file that controls what versions are displayed in the
selector on the website, as well as update the ``latest`` symlink that points to the latest
version of the docs.

-----------
Other Tools
Expand Down

0 comments on commit e995194

Please sign in to comment.