diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f171c43b..5689cbd2 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -16,4 +16,6 @@ python: install: - requirements: requirements.txt -formats: all +formats: + - pdf + - htmlzip diff --git a/README.md b/README.md index e79c1091..f5af34ac 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The documentation can be browsed online and offline. ## Browse OpenMS documentation online 1. https://openms.readthedocs.io/en/develop -2. https://openms.readthedocs.io/en/latest/ +2. https://openms.readthedocs.io/en/latest `develop` denotes the developing version of OpenMS documentation. `latest` corresponds to the OpenMS stable release documentation. @@ -28,12 +28,10 @@ documentation. ## Browse OpenMS documentation offline -1. Download latest [EPUB](https://openms.readthedocs.io/_/downloads/en/latest/epub/). -2. Download latest [PDF](https://openms.readthedocs.io/_/downloads/en/latest/pdf/). -3. Download latest [HTMLZip](https://openms.readthedocs.io/_/downloads/en/latest/htmlzip/). -4. Download develop [EPUB](https://openms.readthedocs.io/_/downloads/en/develop/epub/). -5. Download develop [PDF](https://openms.readthedocs.io/_/downloads/en/develop/pdf/). -6. Download develop [HTMLZip](https://openms.readthedocs.io/_/downloads/en/develop/htmlzip/). +1. Download latest [PDF](https://openms.readthedocs.io/_/downloads/en/latest/pdf/). +2. Download latest [HTMLZip](https://openms.readthedocs.io/_/downloads/en/latest/htmlzip/). +3. Download develop [PDF](https://openms.readthedocs.io/_/downloads/en/develop/pdf/). +4. Download develop [HTMLZip](https://openms.readthedocs.io/_/downloads/en/develop/htmlzip/). ## Build OpenMS Docs locally @@ -51,7 +49,7 @@ As the next step, there are a few options to build OpenMS/OpenMS-docs locally: 2. Run `sphinx-build -a docs /tmp/rtd` to build all files. 3. Run `sphinx-build docs/ /tmp/rtd` to build changed files. -Now, open index.html file to view the changes or output OpenMS ReadTheDocs documentation. +Now, open index.html file to view the changes or output of OpenMS ReadTheDocs documentation. ## Contributing to OpenMS Docs diff --git a/docs/advanced-resources/custom-compilation.md b/docs/advanced-resources/custom-compilation.md index 0cba8b7e..2e636fcb 100644 --- a/docs/advanced-resources/custom-compilation.md +++ b/docs/advanced-resources/custom-compilation.md @@ -6,12 +6,11 @@ To compile with self built compilers and non default standard libraries, follow To choose any specific compiler, instead of the system default, add the whole path to these options for the cmake call: ```{tab} GCC +cmake -DCMAKE_C_COMPILER=/path/to/c-compiler/binary/gcc -DCMAKE_CXX_COMPILER=/path/to/c++-compiler/binary/g++ +``` -`cmake -DCMAKE_C_COMPILER=/path/to/c-compiler/binary/gcc -DCMAKE_CXX_COMPILER=/path/to/c++-compiler/binary/g++` - ``` ```{tab} Clang - -`cmake -DCMAKE_C_COMPILER=/path/to/c-compiler/binary/clang -DCMAKE_CXX_COMPILER=/path/to/c++-compiler/binary/clang++` +cmake -DCMAKE_C_COMPILER=/path/to/c-compiler/binary/clang -DCMAKE_CXX_COMPILER=/path/to/c++-compiler/binary/clang++ ``` To compile OpenMS with clang and a specific GCC stdlib, instead of the system default one: diff --git a/docs/conf.py b/docs/conf.py index 6e12f495..754a3a12 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -96,7 +96,7 @@ html_static_path = ['../_static'] html_css_files = [ - '../css/custom.css', + 'css/custom.css', ] root_doc = 'index'