Doc-Gen
First, what Doc-Gen is not: it does not build documentation nor does it serve any role in what you do after you write the documentation. In fact, it does what its name says: it helps you write documentation.
When I code, I often find it hard to write docstrings; these bits of inline documentation make navigating around the file a hassle. To move all docstrings out of file yet still have them remain recognizable to other libraries, that is the purpose of this library.
How to use this library
This library has a shell script, doc, and a decorator, doc. Pretty easy to remember. To use this library, you have to decorate the functions which you want with doc, like so:
# source.py
@doc
def function(x, y):
return 2 * x + y
Then, in the terminal, you should type doc source.py, and you should see a prompt asking you for a docstring for function.
After that, drop into the shell and check out the docstring of function:
>>> import source
>>> source.function.__doc__
'<whatever you wrote>'
Sweet, isn’t it?
Metadata
Release files for doc-gen 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 | Actions |
|---|---|---|---|---|
| doc-gen-0.0.1.tar.gz | 7.4 kB | Without provenance | Details for doc-gen-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| doc_gen-0.0.1-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for doc_gen-0.0.1-py2.py3-none-any.whl |
Total release size: 12.0 kB
Release files / doc-gen-0.0.1.tar.gz
| Download URL | doc-gen-0.0.1.tar.gz |
|---|---|
| Size | 7.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c57f580541071a0a1f267a75dc1ff26b66f45df91fd1b14cbd70693c7ebdfe96
|
|
BLAKE2b-256 checksum How to use checksums |
a578453c97cb09556f286ef8ef0363fda61b3fe877992b7a96d3b70eaf96f8ba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.25.1
|
Release files / doc_gen-0.0.1-py2.py3-none-any.whl
| Download URL | doc_gen-0.0.1-py2.py3-none-any.whl |
|---|---|
| Size | 4.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
975f27062288e991d527a1a124f8fa673336bd47357de0c286f5e029e8a54714
|
|
BLAKE2b-256 checksum How to use checksums |
23095b18f3f66acf5f07667f52a72db9466fe716476b84a1b7b7f0e343eda171
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.25.1
|
Security for doc-gen 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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.