Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions _static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
div.highlight {
background-color: #f6f8fa;
}
File renamed without changes
15 changes: 13 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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'
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -55,13 +57,15 @@ Contents
.. toctree::
:maxdepth: 2
:caption: Quick Start Guides
:titlesonly:

guides/user-guides/user-quickstart-guide
guides/contributors-quickstart-guide.md

.. toctree::
:maxdepth: 2
:caption: Tutorials
:titlesonly:

tutorials/TOPP/TOPP-tutorial
tutorials/TOPPAS/TOPPAS-tutorial
Expand All @@ -70,13 +74,15 @@ Contents
.. toctree::
:maxdepth: 2
:caption: OpenMS TOPP Tools
:titlesonly:

topp/topp.md
topp/adding-new-tool-to-topp.md

.. toctree::
:maxdepth: 2
:caption: Developer Resources
:titlesonly:

additional-resources/developer-guidelines-for-addding-new-dependent-libraries.md
additional-resources/external-code-using-openms.md
Expand All @@ -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
Expand All @@ -95,6 +102,7 @@ Contents
.. toctree::
:maxdepth: 2
:caption: Frequently Asked Questions
:titlesonly:

faqs/developer-faq.md
faqs/contributor-faq.md
Expand Down
10 changes: 0 additions & 10 deletions docs/installations/build-openms-from-source.md

This file was deleted.

4 changes: 4 additions & 0 deletions docs/installations/installation-on-gnu-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
5 changes: 5 additions & 0 deletions docs/installations/installation-on-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ Make sure `<OpenMS-PATH>` 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`.
Expand Down
4 changes: 4 additions & 0 deletions docs/installations/installation-on-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down