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.0b4.tar.gz
(36.4 kB
view details)
Built Distribution
nics-3.0.0b4-py3-none-any.whl
(41.3 kB
view details)
File details
Details for the file nics-3.0.0b4.tar.gz
.
File metadata
- Download URL: nics-3.0.0b4.tar.gz
- Upload date:
- Size: 36.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 | 0ad1f8b93c462b47b7974af95c8e690593d26efa582b7d79ca735140119058c0 |
|
MD5 | 488a12d07fae0b8542e450f2e6605f31 |
|
BLAKE2b-256 | 3a8f283459461cd3bbbdee411cb1f0d3c9d10af00cf4c55eb746f44525380940 |
File details
Details for the file nics-3.0.0b4-py3-none-any.whl
.
File metadata
- Download URL: nics-3.0.0b4-py3-none-any.whl
- Upload date:
- Size: 41.3 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 | 88cdedb389292bb2ac11d42f56b61a88e07a0e915a6743e51f579baf25212e54 |
|
MD5 | d5d17698852b5a72b6df9ccbb28fa24a |
|
BLAKE2b-256 | a62997e6bff793af884b2e0e0f703f81ce84821a19b091ec13700549d60ffda7 |