Skip to content

Commit

Permalink
Merge branch 'master' into docker-testing
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeitsperre authored Sep 5, 2023
2 parents e0cc4d4 + 28742c3 commit a83e283
Show file tree
Hide file tree
Showing 17 changed files with 136 additions and 1,070 deletions.
41 changes: 3 additions & 38 deletions docs/source/dev/builddocs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,13 @@
Building the docs
=================

These docs are automatically built by ReadTheDocs, but can also be built locally.

To build the docs, grab a copy of the `pavics-sdi`_ repository on github::

git clone https://github.com/Ouranosinc/pavics-sdi.git

This is the repository presently storing the comprehensive documentation for the PAVICS platform. Because PAVICS processes are documented using the `autoprocess` directive, you'll also need to install a few other packages that contribute services for documentation to ::

git clone https://github.com/bird-house/finch.git
cd finch
make clean install
cd ..

There are other requirements (sphinx and a few extensions) that can be installed using `pip` in Python (2 or 3)::
There are requirements (sphinx and a few extensions) that can be installed using `pip`::

pip install -r requirements.txt

Expand All @@ -23,36 +18,6 @@ After installing these libraries, you should be able to build the docs without e
mkdir source/_static
make html

Publishing the docs online
--------------------------

If you have write permissions to `pavics-sdi`_, you can also deploy the html `online <https://ouranosinc.github.io/pavics-sdi/>`_.
To do so for the first time, create a new directory next to the :file:`pavics-sdi` directory and clone the repo into an :file:`html` directory::

mkdir pavics-sdi-docs
cd pavics-sdi-docs
git clone [email protected]:Ouranosinc/pavics-sdi.git html

Then enter :file:`html`, checkout the `gh-pages` branch and enter some voodoo incantations::

cd html
git checkout gh-pages
git symbolic-ref HEAD refs/heads/gh-pages # auto-switches branches to gh-pages
rm .git/index
git clean -fdx

You'll also need to add a :file:`.nojekyll` file to make sure the stylesheets are loaded on github.io::

git add .nojekyll
git commit -m 'added .nojekyll'
git push

You should then be able to go back to pavics-sdi/docs and run make `gh-pages`, which will build the html docs, copy them to the :file:`pavics-sdi-docs` just created and push them to the github gh-branch::

make gh-pages

For more details, see the original `instructions <https://daler.github.io/sphinxdoc-test/includeme.html>`_.


Translations
------------
Expand Down
164 changes: 0 additions & 164 deletions docs/source/dev/configuration.rst

This file was deleted.

Loading

0 comments on commit a83e283

Please sign in to comment.