Loading README.md +23 −6 Original line number Diff line number Diff line Loading @@ -34,16 +34,33 @@ can be built locally by: > pip install sphinx sphinx_rtd_theme sphinx-tabs sphinxcontrib-bibtex ``` 2. Build the documentation: 2. Build the documentation (HTML): ```shell > mkdir build > sphinx-build -b html docs/source_docs/ build $ make # note, "make html" also works ``` The HTML pages will now be located in the `build` directory. Open the `index.html` with your favorite browser: The HTML pages will be located in the `build/html` directory. Open the `index.html` with your favorite browser: ```shell > firefox build/index.html $ firefox build/html/index.html ``` 3. Build the documentation (PDF): You will need xetex. You should be able to get this from your distribution's package repository. On Ubuntu something like ``sudo apt-get install texlive-xetex`` should do the trick. More info at https://www.tug.org/texlive/ ```shell $ make pdf ``` The output file `mfix.pdf` will be in `build/latex` 4. Cleaning up: ``` shell $ make clean ``` Loading
README.md +23 −6 Original line number Diff line number Diff line Loading @@ -34,16 +34,33 @@ can be built locally by: > pip install sphinx sphinx_rtd_theme sphinx-tabs sphinxcontrib-bibtex ``` 2. Build the documentation: 2. Build the documentation (HTML): ```shell > mkdir build > sphinx-build -b html docs/source_docs/ build $ make # note, "make html" also works ``` The HTML pages will now be located in the `build` directory. Open the `index.html` with your favorite browser: The HTML pages will be located in the `build/html` directory. Open the `index.html` with your favorite browser: ```shell > firefox build/index.html $ firefox build/html/index.html ``` 3. Build the documentation (PDF): You will need xetex. You should be able to get this from your distribution's package repository. On Ubuntu something like ``sudo apt-get install texlive-xetex`` should do the trick. More info at https://www.tug.org/texlive/ ```shell $ make pdf ``` The output file `mfix.pdf` will be in `build/latex` 4. Cleaning up: ``` shell $ make clean ```
