Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Python implementation from main specification documentation #77

Merged
merged 5 commits into from
Jun 28, 2024
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
42 changes: 42 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Build documentation

on:
push:
branches:
- main
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Build docs
run: |
sphinx-build -b html docs docs/_build/html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "docs/_build/html/"

deploy:
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
![Watchers](https://flat.badgen.net/github/watchers/HUPO-PSI/mzSpecLib)
![Stars](https://flat.badgen.net/github/stars/HUPO-PSI/mzSpecLib)

**HUPO-PSI standardized spectral library format**
**HUPO-PSI standardized spectral library format**
mzSpecLib is a formal standard and file format in development at
[HUPO-PSI](http://www.psidev.info/) to store and distribute
spectral libraries/archives. The target main target audience for this format are
Expand Down Expand Up @@ -61,16 +61,17 @@ is used as a central point of information regarding the format's development:
- [mzSpecLib general data model schematic](https://drive.google.com/file/d/1OVh5ATfKXA77pM4CYzRfdupeRGu3vt5c/view?usp=sharing)


Currently, the project's progress can be split up into the development of the
[main specification](https://github.com/HUPO-PSI/mzSpecLib/tree/master/specification)
and into a [Python implementation](https://github.com/HUPO-PSI/mzSpecLib/tree/master/implementations/python)
of this specification.
## Reference implementation

A reference implementation of the mzSpecLib format is available in the form of a Python package.
Check out the [mzspeclib-py](https://github.com/HUPO-PSI/mzspeclib-py) repository or the
[Python package documentation](https://mzspeclib.readthedocs.io/) for more information.


## Contributing

All community input is welcome! Feel free to join the discussions in the [Issue
tracker](https://github.com/HUPO-PSI/SpectralLibraryFormat/issues) or to open a
new issue if you have questions, recommendations or requests. Additionally,
new issue if you have questions, recommendations or requests. Additionally,
everyone is allowed to post comments in the Google documents or to request full
write access to fully contribute to the specification.
21 changes: 0 additions & 21 deletions docs/.readthedocs.yaml

This file was deleted.

23 changes: 1 addition & 22 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,7 @@
github_doc_root = "https://github.com/HUPO-PSI/mzSpecLib/tree/master/docs"

# General configuration
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosectionlabel",
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx_click.ext",
"myst_parser",
]
extensions = ["myst_parser"]
source_suffix = [".rst"]
master_doc = "index"
exclude_patterns = ["_build"]
Expand All @@ -35,19 +27,6 @@
]
}

# Autodoc options
autodoc_default_options = {"members": True, "show-inheritance": True}
autodoc_member_order = "bysource"
autodoc_typehints = "description"
autoclass_content = "init"

# Intersphinx options
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"psims": ("https://mobiusklein.github.io/psims/docs/build/html/", None),
"pyteomics": ("https://pyteomics.readthedocs.io/en/stable/", None),
}


def setup(app):
config = {"enable_eval_rst": True} # noqa: F841
11 changes: 0 additions & 11 deletions docs/implementations/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/implementations/python/api.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/implementations/python/cli.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/implementations/python/index.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,4 @@

Home <self>
specification/index
implementations/index
contributing
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
sphinx
pydata_sphinx_theme
myst-parser
Loading