Skip to content
Permalink
Browse files

doc for setting up doxygen with conda

  • Loading branch information...
jkoendev committed Apr 9, 2019
1 parent 0a79065 commit d6b4eb67898168fbc5959d003ce6bbd005a73de7
Showing with 44 additions and 7 deletions.
  1. +5 −0 README.md
  2. +39 −7 docs/README.md
@@ -61,4 +61,9 @@ Both a CMake and a Makefile based build system are supported at the moment.
make run_examples_c
```

If the compilation/linking fails because `-lblas` or `-llapack` can not be found, you might want to do:
```
sudo apt-get install libblas-dev liblapack-dev
```

* soon: binaries for all operating systems available for download (see Releases)
@@ -4,18 +4,50 @@ Based on `sphinx` and markdown

### Prerequisites

Get and install doxygen:
```
wget http://doxygen.nl/files/doxygen-1.8.15.linux.bin.tar.gz
tar xf doxygen-1.8.15.linux.bin.tar.gz
# add path to doxygen/bin to you bashrc
```

This guide shows the *easy* way of using conda to manage virtual environments. You can of course use the environment of your choice to install pip packages.

Get and install miniconda (follow the installation instructions, best to keep default path ~/miniconda3, and say yes to initialize miniconda in your bashrc):
```
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
sh Miniconda3-latest-Linux-x86_64.sh
source ~/.bashrc # or restart your terminal
```

Create an environment for python and activate the environment
```
conda create -n acados_doc python=3.7
conda activate acados_doc
```

Create a python virtualenv and install `sphinx` and `recommonmark`

pip install sphinx
pip install recommonmark
```
conda install sphinx=1.8 # or pip install sphinx
pip install recommonmark
pip install breathe
pip install sphinx_rtd_theme
```

### Building the webpage

After doing your modification to the webpage, you can build the webpage
in the folder with the following command:

# For Linux, MacOS
make html

# For Windows
make.bat html
```
# For Linux, MacOS
cd docs
make html
```

```
# For Windows
cd docs
make.bat html
```

0 comments on commit d6b4eb6

Please sign in to comment.
You can’t perform that action at this time.