Merge branch 'cgw-furo' into 'main' (5277d0ec) · Commits · exa / docs

.gitlab-ci.yml

+1 −4

Changes for .gitlab-ci.yml: 1 added line, 4 removed lines.
Original line number	Diff line number	Diff line
		@@ -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"

+6 −6

Changes for README.md: 6 added lines, 6 removed lines.
Original line number	Diff line number	Diff line
		@@ -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,7 +54,7 @@ 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
		```

		@@ -62,6 +62,6 @@ 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
		```