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

Adding instructions on how to build docs #1779

Merged
merged 8 commits into from
Jun 15, 2022
Merged

Adding instructions on how to build docs #1779

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4c42272
Adding instructions on how to build docs
vincentpierre Jun 9, 2022
6a4a563
adding python path manually
vincentpierre Jun 9, 2022
04e6571
Update docs/README.md
vincentpierre Jun 10, 2022
7cf7fa4
reverting most changes
vincentpierre Jun 14, 2022
97d5787
merging
vincentpierre Jun 14, 2022
21e73bd
forgot to remove a line
vincentpierre Jun 14, 2022
ee44680
forgot to remove a line
vincentpierre Jun 14, 2022
92ef362
Merge branch 'main' into adding_docs_instructions
vincentpierre Jun 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,25 @@ conda install -c conda-forge doxygen==1.8.16
conda install jinja2 pygments docutils
```

To build the docs, you will also need to install the following
packages on Linux :
```
sudo apt install --allow-change-held-packages \
texlive-base \
texlive-latex-extra \
texlive-fonts-extra \
texlive-fonts-recommended
```
or on OSX :
```
brew install --cask mactex
```
__Note__: You might also need to run the following command
as suggested by [this page](https://mcss.mosra.cz/plugins/math-and-code/#math)
```
export PATH=$PATH:/Library/TeX/Distributions/.DefaultTeX/Contents/Programs/texbin
```

### Building Docs:
```bash
python setup.py install
Expand Down