serial-sphinx
Why?
Rapid prototyping requires boilerplate code
What?
serial-sphinx distills field knowledge about using sphinx for uploading your documentation to readthedocs.org.
Follow the blog for more useful info.
Command snippets
rm -r docs
cd docs
sphinx-quickstart
Copy the config file from the repository. Then, in the docs folder
sphinx-apidoc -o source/ ../<package_name>
make html
Make sure you follow the appropriate file structure outlined in the repository.
Push it to you repo with the configured webhook, and you are done.
Proper testing
Please make sure to setup some CI/CD pipeline. If you are avoiding commercial setups, then this is a problem.
For code quality, make sure you have great coverage by using pytest-cov. Check out the provided setup.cfg file.
Woodpecker CI
Open-source CI. But not like Github-actions. Check the .woodpecker.yml for a tested standard workflow.
Code-Coverage
The passing goal for the code-coverage should be edited in the setup.cfg under the key addopts
1 maintainer
Metadata
1 maintainer
Release files for chembee 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| chembee-0.1.0.tar.gz | 13.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| chembee-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.9 kB
Release files / chembee-0.1.0.tar.gz
| Download URL | chembee-0.1.0.tar.gz |
|---|---|
| Size | 13.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9aee6a7ef1fe66e6b014559bc7c9e348af58ccc071843a48d9cc90cb404c67ec
|
|
BLAKE2b-256 checksum How to use checksums |
408ec08c95cca9f7d0319e915aeb9b41d9b4427d4f6b15b1b5c473cebf487130
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.4
|
Release files / chembee-0.1.0-py3-none-any.whl
| Download URL | chembee-0.1.0-py3-none-any.whl |
|---|---|
| Size | 14.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6686637065e07f71e8e6f421af3b199ef31d2e853b9ccaeabd72e795ffc9629f
|
|
BLAKE2b-256 checksum How to use checksums |
4ef3cf6bcfacebb17980d00a01db3a330edc3aebc6bbd7189ac5e72f3cdd9c14
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.4
|
