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.0b9.tar.gz
(36.4 kB
view details)
Built Distribution
nics-3.0.0b9-py3-none-any.whl
(41.3 kB
view details)
File details
Details for the file nics-3.0.0b9.tar.gz
.
File metadata
- Download URL: nics-3.0.0b9.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 | 50637d1c4d915ec8ef1e653782f254453649f72e0492b79079e37f3a3db7c8e2 |
|
MD5 | 76903cdeb3736be241667ca576c7e082 |
|
BLAKE2b-256 | f87e6c904517628a53cd275e4feadefd5f8a901829bbbb5137ce7c1ee2f09c14 |
File details
Details for the file nics-3.0.0b9-py3-none-any.whl
.
File metadata
- Download URL: nics-3.0.0b9-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 | b69a87be4b5f633e1c7fe6af4261a8f35a36589f4b0f3018069fe2806be39b71 |
|
MD5 | 72723e86c8ece0f12355e7a0bffcd04c |
|
BLAKE2b-256 | 074e011c59f97059e5f40208736454f27b4b430b68ab2259e84bedbf3c0c2505 |