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.
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib.readme-to-index 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinxcontrib.readme-to-index-0.0.1.tar.gz | 2.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib.readme_to_index-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.4 kB
Release files / sphinxcontrib.readme-to-index-0.0.1.tar.gz
| Download URL | sphinxcontrib.readme-to-index-0.0.1.tar.gz |
|---|---|
| Size | 2.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5d22772cc3c7ad221768099a2b51cd8c5b2c57b18946ffd70ced581ecf761336
|
|
BLAKE2b-256 checksum How to use checksums |
e34cb712eb4786f75f5cb4bb3094a5ad24f6d7670f871510975c0021da1392c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / sphinxcontrib.readme_to_index-0.0.1-py3-none-any.whl
| Download URL | sphinxcontrib.readme_to_index-0.0.1-py3-none-any.whl |
|---|---|
| Size | 7.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
15fe13d45736b0aa1f1ca813fe7b420328bd4f9a6b4ffd47001dff66aeb600ca
|
|
BLAKE2b-256 checksum How to use checksums |
2f0cdb03513e7543d9ead9b5763677cb405228f48536ee5a12ab3f2b9d82ff36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for sphinxcontrib.readme-to-index 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
