diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 73ee45c08f927bafc8f15b5d6fe43c5e85bca85a..03ab11881e4ffd2632784bea2f8fb426b48a3877 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -15,7 +15,7 @@ workflow: docs:userguide: image: sphinxdoc/sphinx:latest script: - - pip install -q sphinx_rtd_theme sphinx_tabs sphinxcontrib-bibtex + - pip install -q furo sphinx_rtd_theme sphinx_tabs sphinxcontrib-bibtex - sphinx-build -W -b html docs/source_docs/ build/docs - sphinx-build -W -b html docs/picvva/ build/picvva stage: build-docs @@ -54,6 +54,3 @@ deploy:docs: - docker rules: - if: $CI_COMMIT_BRANCH == "main" - - - diff --git a/README.md b/README.md index b4b707c7693db452d2380beac8bcc6bb741f6652..5fb05459fc8994f4d700d0659415b74c96c9cf23 100644 --- a/README.md +++ b/README.md @@ -30,20 +30,20 @@ can be built locally by: 1. Install sphinx: -```shell -> pip install sphinx sphinx_rtd_theme sphinx-tabs sphinxcontrib-bibtex +```console +$ pip install sphinx furo sphinx_rtd_theme sphinx-tabs sphinxcontrib-bibtex ``` 2. Build the documentation (HTML): -```shell +```console $ make # note, "make html" also works ``` The HTML pages will be located in the `build/html` directory. Open the `index.html` with your favorite browser: -```shell +```console $ firefox build/html/index.html ``` @@ -54,14 +54,14 @@ 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 +```console $ make pdf ``` -The output file `mfix.pdf` will be in `build/latex`. PDF output is +The output file `mfix.pdf` will be in `build/latex`. PDF output is experimental at this time and there may be some formatting issues. 4. Cleaning up: -``` shell +```console $ make clean ```