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.0b5.tar.gz
(36.4 kB
view details)
Built Distribution
nics-3.0.0b5-py3-none-any.whl
(41.3 kB
view details)
File details
Details for the file nics-3.0.0b5.tar.gz
.
File metadata
- Download URL: nics-3.0.0b5.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 | e37b478b236cb87ff6e37e9f85f45d2111d3993c5734c17e8891e0603ed23e97 |
|
MD5 | 5531117862d4f75841acc8215cc0993c |
|
BLAKE2b-256 | 688bc2c844a7e909ad45d50875377798eb9c20b4c75291cc255a33100a68ef8c |
File details
Details for the file nics-3.0.0b5-py3-none-any.whl
.
File metadata
- Download URL: nics-3.0.0b5-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 | 0b0f0543b2b335bef754e950e1a4cf254d61cd111e0d5dce7420cfc3b6cfda7c |
|
MD5 | 18bc7badcc9280f1d73037ee254da4c2 |
|
BLAKE2b-256 | 9b544339f8c52b4874c40a12a0bc44835d8e0702bd1e2f38a2314efad2f4e5ef |