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.0b0.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

nics-3.0.0b0-py3-none-any.whl (45.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nics-3.0.0b0.tar.gz
  • Upload date:
  • Size: 40.0 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.0b0.tar.gz
Algorithm Hash digest
SHA256 cd0a873d6a98ad3d8cb6eef262d000fe2550c19f2a7926559b3109a510954593
MD5 695db29ef849548cf352cbaf69091c97
BLAKE2b-256 ee71c7276111d6aa30388e04d9b3c45c1da7c02e26ac9545eddeeea30944f532

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nics-3.0.0b0-py3-none-any.whl
  • Upload date:
  • Size: 45.8 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.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 de3df981a03b7b14c85b74867e1d00b8dbc95aa2f804b86b8046816232d24efe
MD5 b483ac9bac95297757231eb937bb34e1
BLAKE2b-256 d30c511c1f755cea6c606ada37bb13d6d0b345224922c47e5182f93d0ae77c56

See more details on using hashes here.

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