{"id":24557469,"url":"https://github.com/openms/openms-docs","last_synced_at":"2026-03-04T11:30:57.461Z","repository":{"id":37028743,"uuid":"487048750","full_name":"OpenMS/OpenMS-docs","owner":"OpenMS","description":"OpenMS Documentation.","archived":false,"fork":false,"pushed_at":"2025-03-12T15:15:30.000Z","size":36340,"stargazers_count":2,"open_issues_count":63,"forks_count":26,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2025-04-10T15:50:15.638Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"https://openms.readthedocs.io","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenMS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-04-29T16:58:24.000Z","updated_at":"2025-03-12T15:15:35.000Z","dependencies_parsed_at":"2023-10-11T16:06:21.480Z","dependency_job_id":"fc9cec7b-f78b-480a-8b67-b62e527656bf","html_url":"https://github.com/OpenMS/OpenMS-docs","commit_stats":{"total_commits":138,"total_committers":12,"mean_commits":11.5,"dds":0.644927536231884,"last_synced_commit":"8f1c156d6a6539689f8dd1255f16058e815b0864"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenMS%2FOpenMS-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenMS%2FOpenMS-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenMS%2FOpenMS-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenMS%2FOpenMS-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenMS","download_url":"https://codeload.github.com/OpenMS/OpenMS-docs/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249535886,"owners_count":21287496,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2025-01-23T05:16:59.401Z","updated_at":"2025-04-18T19:21:07.050Z","avatar_url":"https://github.com/OpenMS.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"OpenMS Documentation\n====================\n\nThis repository is the home for OpenMS documentation. OpenMS documentation is categorised as per:\n\n- Supported libraries, tools, packages.\n- Users who prefer GUI.\n- Users who prefer working with code.\n- Examples and tutorials of working with OpenMS.\n- Adding functionalities to OpenMS.\n- Extensibility of OpenMS.\n- Developer and contributor documentation.\n- Workshop/Training tutorial.\n- Quick start user and developer guides.\n- Most efficient and user centric OpenMS tools.\n- and a lot of other interesting reads with sample data!\n\nThe documentation can be browsed online and offline.\n\n## Browse OpenMS documentation online\n\n1. https://openms.readthedocs.io/en/develop\n2. https://openms.readthedocs.io/en/latest\n\n`develop` denotes the developing version of OpenMS documentation. `latest` corresponds to the OpenMS stable release\ndocumentation.\n\n\n## Browse OpenMS documentation offline\n\n1. Download latest [PDF](https://openms.readthedocs.io/_/downloads/en/latest/pdf/).\n2. Download latest [HTMLZip](https://openms.readthedocs.io/_/downloads/en/latest/htmlzip/).\n3. Download develop [PDF](https://openms.readthedocs.io/_/downloads/en/develop/pdf/).\n4. Download develop [HTMLZip](https://openms.readthedocs.io/_/downloads/en/develop/htmlzip/).\n\n## Build OpenMS Docs locally\n\nIn the root directory, run\n\n```\npip3 install -r requirements.txt\n```\n\nto install dependencies. It is suggested to create a virtual environment, for more information read [venv](https://docs.python.org/3/library/venv.html) docs.\n\nAs the next step, there are a few options to build OpenMS/OpenMS-docs locally:\n\n1. Run `make html` in root directory.\n2. Run `sphinx-build -a docs /tmp/rtd` to build all files.\n3. Run `sphinx-build docs/ /tmp/rtd` to build changed files.\n\nNow, open index.html file to view the changes or output of OpenMS ReadTheDocs documentation.\n\n## Contributing to OpenMS Docs\n\nPlease read our [contributing guidelines](.github/CONTRIBUTING.md), before starting with contributing to OpenMS\nDocumentation.\n\nLet us know what you would like to read in OpenMS documentation using [GitHub issues](https://github.com/OpenMS/OpenMS-docs/issues/new/choose)!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenms%2Fopenms-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenms%2Fopenms-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenms%2Fopenms-docs/lists"}