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.0b1.tar.gz
(35.4 kB
view details)
Built Distribution
nics-3.0.0b1-py3-none-any.whl
(39.1 kB
view details)
File details
Details for the file nics-3.0.0b1.tar.gz
.
File metadata
- Download URL: nics-3.0.0b1.tar.gz
- Upload date:
- Size: 35.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6738c279bcdda2b2b660489e87e24eeda8e538e6111a3e9eb79d1f41da1ba02c |
|
MD5 | 405004e5dc928be43419fe65773f84ef |
|
BLAKE2b-256 | c368e85020b4a5791b12ef672a13d57fb3b89d28255cc446fd0b5f59352a6e90 |
File details
Details for the file nics-3.0.0b1-py3-none-any.whl
.
File metadata
- Download URL: nics-3.0.0b1-py3-none-any.whl
- Upload date:
- Size: 39.1 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 | 46fe75582bece2fa79277250d2c63c753e3c46a8f29eb47af94232139c87ab99 |
|
MD5 | aef7da0bc069c83ab537f7b26ee5427b |
|
BLAKE2b-256 | a9144b92ee124ed193c97d9006ff6bdcddd971d91fc467c99dc131e43bee99c3 |