You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
131 lines
4.2 KiB
131 lines
4.2 KiB
Metadata-Version: 2.1
|
|
Name: furo
|
|
Version: 2020.12.9b21
|
|
Summary: A clean customisable Sphinx documentation theme.
|
|
Home-page: https://github.com/pradyunsg/furo
|
|
License: UNKNOWN
|
|
Author: Pradyun Gedam
|
|
Author-email: mail@pradyunsg.me
|
|
Requires-Python: >=3.5
|
|
Description-Content-Type: text/markdown
|
|
Classifier: Framework :: Sphinx
|
|
Classifier: Framework :: Sphinx :: Theme
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Environment :: Web Environment
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.5
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Programming Language :: Python :: 3.8
|
|
Classifier: Programming Language :: Python :: 3.9
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Topic :: Documentation
|
|
Classifier: Topic :: Software Development :: Documentation
|
|
Requires-Dist: beautifulsoup4
|
|
Requires-Dist: sphinx > 3.0
|
|
Requires-Dist: myst-parser ; extra == "doc"
|
|
Requires-Dist: sphinx-inline-tabs ; extra == "doc"
|
|
Requires-Dist: pytest ; extra == "test"
|
|
Requires-Dist: pytest-cov ; extra == "test"
|
|
Requires-Dist: pytest-xdist ; extra == "test"
|
|
Provides-Extra: doc
|
|
Provides-Extra: test
|
|
|
|
<h1 align="center">Furo</h1>
|
|
<p align="center">
|
|
A clean customisable <a href="https://www.sphinx-doc.org/">Sphinx</a> documentation theme.
|
|
</p>
|
|
<a href="https://pradyunsg.me/furo/">
|
|
<img align="center" src="https://github.com/pradyunsg/furo/raw/main/docs/_static/demo.png" alt="Demo image">
|
|
</a>
|
|
|
|
## Elevator pitch
|
|
|
|
<!-- start elevator-pitch -->
|
|
|
|
- **Intentionally minimal** --- the most important thing is the content, not the scaffolding around it.
|
|
- **Responsive** --- adapting perfectly to the available screen space, to work on all sorts of devices.
|
|
- **Customisable** --- change the color palette, font families, logo and more!
|
|
- **Easy to navigate** --- with carefully-designed sidebar navigation and inter-page links.
|
|
- **Good looking content** --- through clear typography and well-stylised elements.
|
|
- **Good looking search** --- helps readers find what they want quickly.
|
|
- **Biased for smaller docsets** --- intended for smaller documentation sets, where presenting the entire hierarchy in the sidebar is not overwhelming.
|
|
|
|
<!-- end elevator-pitch -->
|
|
|
|
## Quickstart
|
|
|
|
<!-- start quickstart -->
|
|
|
|
Furo is distributed on [PyPI]. To use the theme in your Sphinx project:
|
|
|
|
1. Install Furo in documentation's build environment.
|
|
|
|
```
|
|
pip install furo
|
|
```
|
|
|
|
2. Update the `html_theme` in `conf.py`.
|
|
|
|
```py
|
|
html_theme = "furo"
|
|
```
|
|
|
|
3. Your Sphinx documentation's HTML pages will now be generated with this theme! 🎉
|
|
|
|
[pypi]: https://pypi.org/project/furo/
|
|
|
|
<!-- end quickstart -->
|
|
|
|
For more information, visit [Furo's documentation][quickstart-docs].
|
|
|
|
[quickstart-docs]: https://pradyunsg.me/furo/quickstart
|
|
|
|
## Contributing
|
|
|
|
Furo is a volunteer maintained open source project, and we welcome contributions of all forms. Please take a look at our [Contributing Guide](https://pradyunsg.me/furo/contributing/) for more information.
|
|
|
|
## Acknowledgements
|
|
|
|
Furo is inspired by (and borrows elements from) some excellent technical documentation themes:
|
|
|
|
- [mkdocs-material] for MkDocs
|
|
- [Just the Docs] for Jekyll
|
|
- [GitBook]
|
|
|
|
We use [BrowserStack] to test on real devices and browsers. Shoutout to them for supporting OSS projects!
|
|
|
|
[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/
|
|
[just the docs]: https://pmarsceill.github.io/just-the-docs/
|
|
[gitbook]: https://www.gitbook.com/
|
|
[browserstack]: https://browserstack.com/
|
|
|
|
## Used By
|
|
|
|
<!-- start used-by -->
|
|
|
|
> I'm being told that mentioning who uses `$thing` is a good way to promote `$thing`.
|
|
|
|
- [urllib3] -- THE first adopter of Furo.
|
|
- [attrs] (also one of the early adopters!)
|
|
- [psycopg3]
|
|
- [pip]
|
|
- [packaging]
|
|
|
|
I'm also a maintainer on the last two, so... that covers responsible disclosure. :)
|
|
|
|
[urllib3]: https://urllib3.readthedocs.io/
|
|
[attrs]: https://www.attrs.org/
|
|
[psycopg3]: https://www.psycopg.org/psycopg3/docs/
|
|
[pip]: https://pip.pypa.io/
|
|
[packaging]: https://packaging.pypa.io/
|
|
|
|
<!-- end used-by -->
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License.
|
|
|