From 3c6b7cd0caa1550859b8edc70f459d47cbb0ea44 Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Fri, 29 Jul 2022 18:48:36 +0530 Subject: [PATCH 1/6] tabs error ref: https://github.com/OpenMS/OpenMS-docs/pull/146 --- docs/advanced-resources/custom-compilation.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/advanced-resources/custom-compilation.md b/docs/advanced-resources/custom-compilation.md index 0cba8b7e..33601057 100644 --- a/docs/advanced-resources/custom-compilation.md +++ b/docs/advanced-resources/custom-compilation.md @@ -7,11 +7,14 @@ To choose any specific compiler, instead of the system default, add the whole pa ```{tab} GCC -`cmake -DCMAKE_C_COMPILER=/path/to/c-compiler/binary/gcc -DCMAKE_CXX_COMPILER=/path/to/c++-compiler/binary/g++` - ``` +```bash +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++` +```bash +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: From b843bc22b52cba055559021e005ce8192f8a1002 Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Fri, 29 Jul 2022 19:04:11 +0530 Subject: [PATCH 2/6] Fix css not found --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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' From 9abd713c47dc3a437bc56f7bd47dde227aac3fbf Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Fri, 29 Jul 2022 19:19:53 +0530 Subject: [PATCH 3/6] minimal tab for custom_compilation.md --- docs/advanced-resources/custom-compilation.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/advanced-resources/custom-compilation.md b/docs/advanced-resources/custom-compilation.md index 33601057..2e636fcb 100644 --- a/docs/advanced-resources/custom-compilation.md +++ b/docs/advanced-resources/custom-compilation.md @@ -6,14 +6,10 @@ 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 - -```bash cmake -DCMAKE_C_COMPILER=/path/to/c-compiler/binary/gcc -DCMAKE_CXX_COMPILER=/path/to/c++-compiler/binary/g++ ``` ```{tab} Clang - -```bash cmake -DCMAKE_C_COMPILER=/path/to/c-compiler/binary/clang -DCMAKE_CXX_COMPILER=/path/to/c++-compiler/binary/clang++ ``` From c3e857184bd77bd3d85b6d69551f0549da6859ba Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Fri, 29 Jul 2022 19:24:13 +0530 Subject: [PATCH 4/6] failing command is epub generation ref: https://pastebin.com/9PTWprLD --- .readthedocs.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f171c43b..28ce1442 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -16,4 +16,5 @@ python: install: - requirements: requirements.txt -formats: all +formats: + - pdf From 0e127d0ad9cbeb6b0e848fd0a5ffd30ee24d64c9 Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Fri, 29 Jul 2022 19:31:09 +0530 Subject: [PATCH 5/6] add htmlzip to formats --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 28ce1442..5689cbd2 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -18,3 +18,4 @@ python: formats: - pdf + - htmlzip From cdd70f296c77f5c103c51851e926fdb25345c664 Mon Sep 17 00:00:00 2001 From: Tapasweni Pathak Date: Fri, 29 Jul 2022 19:34:11 +0530 Subject: [PATCH 6/6] stable: w/o epub https://openms-staging.readthedocs.io/en/tabs --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) 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