diff --git a/_static/css/custom.css b/_static/css/custom.css new file mode 100644 index 00000000..50ef9f6b --- /dev/null +++ b/_static/css/custom.css @@ -0,0 +1,3 @@ +div.highlight { + background-color: #f6f8fa; +} diff --git a/assets/OpenMS.svg b/assets/logo/OpenMS.svg similarity index 100% rename from assets/OpenMS.svg rename to assets/logo/OpenMS.svg diff --git a/assets/OpenMS_transparent_background.png b/assets/logo/OpenMS_transparent_background.png similarity index 100% rename from assets/OpenMS_transparent_background.png rename to assets/logo/OpenMS_transparent_background.png diff --git a/conf.py b/conf.py index 0524eee0..8a58fb5e 100644 --- a/conf.py +++ b/conf.py @@ -67,8 +67,15 @@ # a list of builtin themes. # html_theme = 'furo' -html_logo = 'assets/OpenMS_transparent_background.png' - +html_logo = 'assets/logo/OpenMS_transparent_background.png' +html_theme_options = { + "navigation_with_keys": True, + "light_css_variables": { + "font-stack--monospace": "Consolas, monospace", + "font-size--small": "90%", + "toc-font-size": "87.5%" + }, +} pygments_style = 'sas' pygments_dark_style = 'rrt' @@ -79,4 +86,8 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +html_css_files = [ + 'css/custom.css', +] + root_doc = 'docs/index' diff --git a/docs/index.rst b/docs/index.rst index eb92fa7a..27ec7eb1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,12 +40,14 @@ Contents .. toctree:: :maxdepth: 2 :caption: Introduction + :titlesonly: introduction .. toctree:: :maxdepth: 2 :caption: Getting Started + :titlesonly: installations/installation-on-gnu-linux installations/installation-on-windows @@ -55,6 +57,7 @@ Contents .. toctree:: :maxdepth: 2 :caption: Quick Start Guides + :titlesonly: guides/user-guides/user-quickstart-guide guides/contributors-quickstart-guide.md @@ -62,6 +65,7 @@ Contents .. toctree:: :maxdepth: 2 :caption: Tutorials + :titlesonly: tutorials/TOPP/TOPP-tutorial tutorials/TOPPAS/TOPPAS-tutorial @@ -70,6 +74,7 @@ Contents .. toctree:: :maxdepth: 2 :caption: OpenMS TOPP Tools + :titlesonly: topp/topp.md topp/adding-new-tool-to-topp.md @@ -77,6 +82,7 @@ Contents .. toctree:: :maxdepth: 2 :caption: Developer Resources + :titlesonly: additional-resources/developer-guidelines-for-addding-new-dependent-libraries.md additional-resources/external-code-using-openms.md @@ -86,6 +92,7 @@ Contents .. toctree:: :maxdepth: 2 :caption: OpenMS GitHub Workflow + :titlesonly: additional-resources/openms-git-workflow.md additional-resources/reporting-bugs-and-issues.md @@ -95,6 +102,7 @@ Contents .. toctree:: :maxdepth: 2 :caption: Frequently Asked Questions + :titlesonly: faqs/developer-faq.md faqs/contributor-faq.md diff --git a/docs/installations/build-openms-from-source.md b/docs/installations/build-openms-from-source.md deleted file mode 100644 index eba43512..00000000 --- a/docs/installations/build-openms-from-source.md +++ /dev/null @@ -1,10 +0,0 @@ -Build OpenMS from Source -======================== - -To build OpenMS, please follow the build instructions for: - -* [Linux](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/release/latest/html/install_linux.html) -* [macOS](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/release/latest/html/install_mac.html) -* [Windows](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/release/latest/html/install_win.html) - -Instructions to build {term}`pyOpenMS` can be found in the [pyOpenMS documentation](https://pyopenms.readthedocs.io/en/latest/build_from_source.html). diff --git a/docs/installations/installation-on-gnu-linux.md b/docs/installations/installation-on-gnu-linux.md index f6482b31..c0b1177c 100644 --- a/docs/installations/installation-on-gnu-linux.md +++ b/docs/installations/installation-on-gnu-linux.md @@ -123,3 +123,7 @@ docker pull openms/pyopenms Dockerfiles to build different kind of images (corresponding to build instructions, e.g. on ArchLinux) can be found on GitHub in [OpenMS/dockerfiles](https://github.com/OpenMS/dockerfiles) repository. + +## Build OpenMS from source + +To build OpenMS from source, follow the build instructions for [Linux](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/release/latest/html/install_linux.html). diff --git a/docs/installations/installation-on-macos.md b/docs/installations/installation-on-macos.md index 61f99282..4e1769c3 100644 --- a/docs/installations/installation-on-macos.md +++ b/docs/installations/installation-on-macos.md @@ -41,6 +41,11 @@ Make sure `` points to the folder where OpenMS is installed locally Follow [these](installation-on-gnu-linux.md#install-via-conda) instructions. + +## Build OpenMS from source + +To build OpenMS from source, follow the build instructions for [macOS](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/release/latest/html/install_mac.html). + ## Known Issues 1. OpenMS software landing in quarantine since macOS Catalina after installation of the `.dmg`. diff --git a/docs/installations/installation-on-windows.md b/docs/installations/installation-on-windows.md index c9848c77..9ba0b18a 100644 --- a/docs/installations/installation-on-windows.md +++ b/docs/installations/installation-on-windows.md @@ -14,6 +14,10 @@ The windows binary version works with most versions of windows from Win7 to Win1 still work but are untested). ``` +## Build OpenMS from source + +To build OpenMS from source, follow the build instructions for [Windows](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/release/latest/html/install_win.html). + ## Known issues 1. During installation, an error message pops up, saying "The installation of the Microsoft .NET 3.5 SP1' package failed!