# The WMO Sphinx Theme
A [Sphinx](https://python-sphinx.org) theme for documenting WMO projects.
## Installation and usage
The theme is available on [PyPI](https://pypi.org/project/wmo-sphinx-theme), and can
be installed as follows:
```bash
pip3 install wmo-sphinx-theme
```
Enavbling the theme from within your project's `conf.py`:
```python
import wmo_sphinx_theme
html_theme = 'wmo_sphinx_theme'
html_theme_path = wmo_sphinx_theme.get_html_theme_path()
html_css_files = ['wmo.css']
```
## Releasing
```bash
rm -fr build dist *.egg-info
python3 setup.py sdist bdist_wheel --universal
twine upload dist/*
```
### Code Conventions
* [PEP8](https://www.python.org/dev/peps/pep-0008)
### Bugs and Issues
All bugs, enhancements and issues are managed on [GitHub](https://github.com/wmo-im/wmo-sphinx-theme/issues).
## Contact
* [Maaike Limper](https://github.com/maaikelimper)
Raw data
{
"_id": null,
"home_page": "https://github.com/wmo-im/wmo-sphinx-theme",
"name": "wmo-sphinx-theme",
"maintainer": "Maaike Limper",
"docs_url": null,
"requires_python": "",
"maintainer_email": "mlimper@wmo.int",
"keywords": "wmo",
"author": "Maaike Limper",
"author_email": "mlimper@wmo.int",
"download_url": "https://files.pythonhosted.org/packages/3e/01/a43895f641baa578ef7004931fa44dd13dcd89f7d6b80e20914164b7d148/wmo-sphinx-theme-0.1.2.tar.gz",
"platform": "all",
"description": "# The WMO Sphinx Theme\n\nA [Sphinx](https://python-sphinx.org) theme for documenting WMO projects.\n\n## Installation and usage\n\nThe theme is available on [PyPI](https://pypi.org/project/wmo-sphinx-theme), and can\nbe installed as follows:\n\n```bash\npip3 install wmo-sphinx-theme\n```\n\nEnavbling the theme from within your project's `conf.py`:\n\n```python\nimport wmo_sphinx_theme\n\nhtml_theme = 'wmo_sphinx_theme'\nhtml_theme_path = wmo_sphinx_theme.get_html_theme_path()\n\nhtml_css_files = ['wmo.css']\n```\n\n## Releasing\n\n```bash\nrm -fr build dist *.egg-info\npython3 setup.py sdist bdist_wheel --universal\ntwine upload dist/*\n```\n\n### Code Conventions\n\n* [PEP8](https://www.python.org/dev/peps/pep-0008)\n\n### Bugs and Issues\n\nAll bugs, enhancements and issues are managed on [GitHub](https://github.com/wmo-im/wmo-sphinx-theme/issues).\n\n## Contact\n\n* [Maaike Limper](https://github.com/maaikelimper)\n\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Sphinx theme for WMO projects",
"version": "0.1.2",
"split_keywords": [
"wmo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82742a723f8a53ad593d0bb10b21736502b0fa7005e4b4ac2bfc78181610a99e",
"md5": "b5c3248c15ee16324047bd4f520331dd",
"sha256": "3f116f8a173d1c1cc87da490d5a477c5e58c0ff2524dc02c5d72d960e6db04b0"
},
"downloads": -1,
"filename": "wmo_sphinx_theme-0.1.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5c3248c15ee16324047bd4f520331dd",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 11484,
"upload_time": "2023-01-19T15:16:40",
"upload_time_iso_8601": "2023-01-19T15:16:40.984354Z",
"url": "https://files.pythonhosted.org/packages/82/74/2a723f8a53ad593d0bb10b21736502b0fa7005e4b4ac2bfc78181610a99e/wmo_sphinx_theme-0.1.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3e01a43895f641baa578ef7004931fa44dd13dcd89f7d6b80e20914164b7d148",
"md5": "9afd30ba078805a110da4bdf82c7fffc",
"sha256": "87bcd00b93de22860e48a355e230e56fec1ad34e75383a4d0e55b0a8a388b838"
},
"downloads": -1,
"filename": "wmo-sphinx-theme-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "9afd30ba078805a110da4bdf82c7fffc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11220,
"upload_time": "2023-01-19T15:16:43",
"upload_time_iso_8601": "2023-01-19T15:16:43.192974Z",
"url": "https://files.pythonhosted.org/packages/3e/01/a43895f641baa578ef7004931fa44dd13dcd89f7d6b80e20914164b7d148/wmo-sphinx-theme-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-19 15:16:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "wmo-im",
"github_project": "wmo-sphinx-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "wmo-sphinx-theme"
}