| Name | furo JSON |
| Version |
2024.7.18
JSON |
| download |
| home_page | None |
| Summary | A clean customisable Sphinx documentation theme. |
| upload_time | 2024-07-18 08:19:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Copyright (c) 2020 Pradyun Gedam <mail@pradyunsg.me> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<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.
```text
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]
- [pdoc3]
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://just-the-docs.github.io/just-the-docs/
[gitbook]: https://www.gitbook.com/
[pdoc3]: https://pdoc3.github.io/pdoc/doc
[browserstack]: https://browserstack.com/
## What's with the name?
I plucked this from the scientific name for [Domesticated Ferrets](https://en.wikipedia.org/wiki/Ferret): Mustela putorius **furo**.
A ferret is actually a really good spirit animal for this project: cute, small, steals little things from various places, and hisses at you when you try to make it do things it doesn't like.
> I plan on commissioning a logo for this project (or making one myself) consisting of a cute ferret. Please reach out if you're interested!
## 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] -- one of the early adopters!
- [pip] -- what I wrote this for
- [Python Developer’s Guide][devguide]
- [black]
[urllib3]: https://urllib3.readthedocs.io/
[attrs]: https://www.attrs.org/
[devguide]: https://devguide.python.org/
[pip]: https://pip.pypa.io/
[psycopg3]: https://www.psycopg.org/psycopg3/docs/
[black]: https://black.readthedocs.io/en/stable/
[pelican]: https://docs.getpelican.com/en/latest/
<!-- end used-by -->
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": null,
"name": "furo",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Pradyun Gedam <mail@pradyunsg.me>",
"download_url": "https://files.pythonhosted.org/packages/61/26/cb5b8d330514f4184a44c3998de5debfe8fa3d9383105b42d26e7df84fe8/furo-2024.7.18.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">Furo</h1>\n<p align=\"center\">\n A clean customisable <a href=\"https://www.sphinx-doc.org/\">Sphinx</a> documentation theme.\n</p>\n<a href=\"https://pradyunsg.me/furo/\">\n <img align=\"center\" src=\"https://github.com/pradyunsg/furo/raw/main/docs/_static/demo.png\" alt=\"Demo image\">\n</a>\n\n## Elevator pitch\n\n<!-- start elevator-pitch -->\n\n- **Intentionally minimal** --- the most important thing is the content, not the scaffolding around it.\n- **Responsive** --- adapting perfectly to the available screen space, to work on all sorts of devices.\n- **Customisable** --- change the color palette, font families, logo and more!\n- **Easy to navigate** --- with carefully-designed sidebar navigation and inter-page links.\n- **Good looking content** --- through clear typography and well-stylised elements.\n- **Good looking search** --- helps readers find what they want quickly.\n- **Biased for smaller docsets** --- intended for smaller documentation sets, where presenting the entire hierarchy in the sidebar is not overwhelming.\n\n<!-- end elevator-pitch -->\n\n## Quickstart\n\n<!-- start quickstart -->\n\nFuro is distributed on [PyPI]. To use the theme in your Sphinx project:\n\n1. Install Furo in documentation's build environment.\n\n ```text\n pip install furo\n ```\n\n2. Update the `html_theme` in `conf.py`.\n\n ```py\n html_theme = \"furo\"\n ```\n\n3. Your Sphinx documentation's HTML pages will now be generated with this theme! \ud83c\udf89\n\n[pypi]: https://pypi.org/project/furo/\n\n<!-- end quickstart -->\n\nFor more information, visit [Furo's documentation][quickstart-docs].\n\n[quickstart-docs]: https://pradyunsg.me/furo/quickstart\n\n## Contributing\n\nFuro 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.\n\n## Acknowledgements\n\nFuro is inspired by (and borrows elements from) some excellent technical documentation themes:\n\n- [mkdocs-material] for MkDocs\n- [Just the Docs] for Jekyll\n- [GitBook]\n- [pdoc3]\n\nWe use [BrowserStack] to test on real devices and browsers. Shoutout to them for supporting OSS projects!\n\n[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/\n[just the docs]: https://just-the-docs.github.io/just-the-docs/\n[gitbook]: https://www.gitbook.com/\n[pdoc3]: https://pdoc3.github.io/pdoc/doc\n[browserstack]: https://browserstack.com/\n\n## What's with the name?\n\nI plucked this from the scientific name for [Domesticated Ferrets](https://en.wikipedia.org/wiki/Ferret): Mustela putorius **furo**.\n\nA ferret is actually a really good spirit animal for this project: cute, small, steals little things from various places, and hisses at you when you try to make it do things it doesn't like.\n\n> I plan on commissioning a logo for this project (or making one myself) consisting of a cute ferret. Please reach out if you're interested!\n\n## Used By\n\n<!-- start used-by -->\n\n> I'm being told that mentioning who uses `$thing` is a good way to promote `$thing`.\n\n- [urllib3] -- THE first adopter of Furo\n- [attrs] -- one of the early adopters!\n- [pip] -- what I wrote this for\n- [Python Developer\u2019s Guide][devguide]\n- [black]\n\n[urllib3]: https://urllib3.readthedocs.io/\n[attrs]: https://www.attrs.org/\n[devguide]: https://devguide.python.org/\n[pip]: https://pip.pypa.io/\n[psycopg3]: https://www.psycopg.org/psycopg3/docs/\n[black]: https://black.readthedocs.io/en/stable/\n[pelican]: https://docs.getpelican.com/en/latest/\n\n<!-- end used-by -->\n\n## License\n\nThis project is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2020 Pradyun Gedam <mail@pradyunsg.me> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A clean customisable Sphinx documentation theme.",
"version": "2024.7.18",
"project_urls": {
"Github": "https://github.com/pradyunsg/furo"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e09be3247f1635ae5976d26333304fca7ddf1f18520eb9ad389e1ce3bb924131",
"md5": "0e5f2c80f3c995d27c33b8feea79f49e",
"sha256": "b192c7c1f59805494c8ed606d9375fdac6e6ba8178e747e72bc116745fb7e13f"
},
"downloads": -1,
"filename": "furo-2024.7.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e5f2c80f3c995d27c33b8feea79f49e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 340824,
"upload_time": "2024-07-18T08:19:23",
"upload_time_iso_8601": "2024-07-18T08:19:23.401173Z",
"url": "https://files.pythonhosted.org/packages/e0/9b/e3247f1635ae5976d26333304fca7ddf1f18520eb9ad389e1ce3bb924131/furo-2024.7.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6126cb5b8d330514f4184a44c3998de5debfe8fa3d9383105b42d26e7df84fe8",
"md5": "799ee6a9f5338f5d80c0ba1bcc738b9d",
"sha256": "37b08c5fccc95d46d8712c8be97acd46043963895edde05b0f4f135d58325c83"
},
"downloads": -1,
"filename": "furo-2024.7.18.tar.gz",
"has_sig": false,
"md5_digest": "799ee6a9f5338f5d80c0ba1bcc738b9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1661386,
"upload_time": "2024-07-18T08:19:25",
"upload_time_iso_8601": "2024-07-18T08:19:25.955373Z",
"url": "https://files.pythonhosted.org/packages/61/26/cb5b8d330514f4184a44c3998de5debfe8fa3d9383105b42d26e7df84fe8/furo-2024.7.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-18 08:19:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pradyunsg",
"github_project": "furo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "furo"
}
