Copies README.html to index.html in the build direcotory.
Project description
A sphinx extension to copy README.html to index.html in the build directory.
Overview
In some cases documentation written on GitHub is published on other places, like ReadTheDocs. GitHub automatically renders the README.md file when a directory is opened, while in other environments the index.html is opened. This extension copies the generated README.md files to index.html. If an index.html is already exist in the directory it is not written over.
Links
Contributing
Please feel free to create a pr for code contributions or an issue for issues.
License
Licensed with Apache License 2.0 License, see the LICENSE file.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinxcontrib.readme-to-index-0.0.1.tar.gz.
File metadata
- Download URL: sphinxcontrib.readme-to-index-0.0.1.tar.gz
- Upload date:
- Size: 2.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5d22772cc3c7ad221768099a2b51cd8c5b2c57b18946ffd70ced581ecf761336
|
|
| MD5 |
ef4703d521691a115e5e52ecd1539661
|
|
| BLAKE2b-256 |
e34cb712eb4786f75f5cb4bb3094a5ad24f6d7670f871510975c0021da1392c5
|
File details
Details for the file sphinxcontrib.readme_to_index-0.0.1-py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib.readme_to_index-0.0.1-py3-none-any.whl
- Upload date:
- Size: 7.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
15fe13d45736b0aa1f1ca813fe7b420328bd4f9a6b4ffd47001dff66aeb600ca
|
|
| MD5 |
1c3d46554f6aea091c3561c84994c66c
|
|
| BLAKE2b-256 |
2f0cdb03513e7543d9ead9b5763677cb405228f48536ee5a12ab3f2b9d82ff36
|
