Skip to main content

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  <────────┘

NICS' banner

Rebuild docs pypi version MIT License

Installation

  1. Install via pip, run pip install nics
  2. Navigate to your project root folder
  3. Run nics init
  4. 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.0b6.tar.gz (36.4 kB view details)

Uploaded Source

Built Distribution

nics-3.0.0b6-py3-none-any.whl (41.3 kB view details)

Uploaded Python 3

File details

Details for the file nics-3.0.0b6.tar.gz.

File metadata

  • Download URL: nics-3.0.0b6.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

Hashes for nics-3.0.0b6.tar.gz
Algorithm Hash digest
SHA256 79a2e0953ea52cf8a9c685aee6f7911a2166f450fe617aadbe97574c430909d0
MD5 9be4a3ca86a026cd256c829b499b153e
BLAKE2b-256 735823867426663a07bffc92280df4ceaaad43d16df930caac8f9e5aad9f0f40

See more details on using hashes here.

Provenance

File details

Details for the file nics-3.0.0b6-py3-none-any.whl.

File metadata

  • Download URL: nics-3.0.0b6-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

Hashes for nics-3.0.0b6-py3-none-any.whl
Algorithm Hash digest
SHA256 acfd060b6eb1d038605458209d96f1f785ce39502a9e46151b6c75488c8fd4fd
MD5 55eb1bb7b1192dba794e9a6f37b31c99
BLAKE2b-256 208b75fca242f0652a2fef472545a9a3e02f70a2431937c2fb4b7d78f4cbe679

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page