OpenMS Documentation
This repository is the home for OpenMS documentation. OpenMS documentation is categorised as per:
- Supported libraries, tools, packages.
- Users who prefer GUI.
- Users who prefer working with code.
- Examples and tutorials of working with OpenMS.
- Adding functionalities to OpenMS.
- Extensibility of OpenMS.
- Developer and contributor documentation.
- Workshop/Training tutorial.
- Quick start user and developer guides.
- Most efficient and user centric OpenMS tools.
- and a lot of other interesting reads with sample data!
The documentation can be browsed online and offline.
Browse OpenMS documentation online
develop
denotes the developing version of OpenMS documentation. latest
corresponds to the OpenMS stable release
documentation.
Browse OpenMS documentation offline
Build OpenMS Docs locally
In the root directory, run
pip3 install -r requirements.txt
to install dependencies. It is suggested to create a virtual environment, for more information read venv docs.
As the next step, there are a few options to build OpenMS/OpenMS-docs locally:
- Run
make html
in root directory. - Run
sphinx-build -a docs /tmp/rtd
to build all files. - Run
sphinx-build docs/ /tmp/rtd
to build changed files.
Now, open index.html file to view the changes or output of OpenMS ReadTheDocs documentation.
Contributing to OpenMS Docs
Please read our contributing guidelines, before starting with contributing to OpenMS Documentation.
Let us know what you would like to read in OpenMS documentation using GitHub issues!