Skip to content

Commit

Permalink
add pandoc to build documentation in action
Browse files Browse the repository at this point in the history
  • Loading branch information
ManonMarchand committed Aug 29, 2023
1 parent e35d54a commit 1dd3142
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/workflows/cov-and-doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ jobs:
python -m pytest -v -s --doctest-modules python/mocpy --cov-report=term --cov=python/mocpy
# Install dependencies needed to build the docs
pip install -r requirements/docs.txt
sudo apt-get install pandoc
# Compile the docs and run the test examples
cd ./docs
# * Generate the HTML files
Expand Down
3 changes: 3 additions & 0 deletions docs/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,9 @@ this will generate an ``htmlcov`` folder where all the static html files can be
Building the documentation
--------------------------

To see the documentation locally, you'll need to install the python packages in
:file:`requirements/docs.txt` and the pandoc software.

- To build the docs from the repo directory::

cd docs
Expand Down
1 change: 0 additions & 1 deletion requirements/docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ matplotlib
nbsphinx
networkx>=2.5
numpydoc
pandoc
requests
sphinx>7.0.0 # autoclass does not show properties in older versions
sphinx-astropy
Expand Down

0 comments on commit 1dd3142

Please sign in to comment.