Automated markdown-based documentation page workflow
Project description
Now I Can Sleep
Minimal settings, markdown-based automated documentation workflow for GitHub repositories.
Manual workflow:
┌──────────> Make changes ────────────┐
| v
Deploy docs-page Update docs-files
^ │
└───────── Rebuild docs-page <────────┘
With NICS:
┌──────────> Make changes ────────────┐
| |
└───────── Update docs-files <────────┘
Installation
- Install via pip, run
pip install nics
- Navigate to your project root folder
- Run
nics init
- Follow the wizard, and you all set!
Links
Troubleshoot
- To report bugs or ask questions, please open an issue or submit a pull request.
License
This project is licensed under the MIT license.
Project details
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
nics-3.0.0b2.tar.gz
(36.3 kB
view details)
Built Distribution
nics-3.0.0b2-py3-none-any.whl
(41.2 kB
view details)
File details
Details for the file nics-3.0.0b2.tar.gz
.
File metadata
- Download URL: nics-3.0.0b2.tar.gz
- Upload date:
- Size: 36.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac1aba196684de72755dd9b257aff54717be7b5acf1ff23afb2e01967b6aaeb0 |
|
MD5 | d76062c03add9b4d89e54ddf7b8712c8 |
|
BLAKE2b-256 | d89fe0a690c97c197d978259306e712f3f9c53a391edc5be5840bfbe344ef11e |
File details
Details for the file nics-3.0.0b2-py3-none-any.whl
.
File metadata
- Download URL: nics-3.0.0b2-py3-none-any.whl
- Upload date:
- Size: 41.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a100c87a00ef9f9ef3ffc9d0e36215d9346d2ca5ed8611e077dd7d03fe165e31 |
|
MD5 | 6b5ba8a90c25af3c217c6911fccfc780 |
|
BLAKE2b-256 | ee18486d000caf27dee6b4e25f533783e69f897b8527107347e97bbc9829c933 |