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

Uploaded Source

Built Distribution

nics-3.0.0b3-py3-none-any.whl (41.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nics-3.0.0b3.tar.gz
  • Upload date:
  • Size: 36.3 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.0b3.tar.gz
Algorithm Hash digest
SHA256 80f0e9a8f04d0db2395a73cc6dc292f601e6f0368c235a16c9f034376e4bc255
MD5 00d880ae6dfc84adae00708ec3d392c6
BLAKE2b-256 88fa6c21d26991e0d8505e474a4c5308e02ad3af976274bd657a4ac09aa4ecec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nics-3.0.0b3-py3-none-any.whl
  • Upload date:
  • Size: 41.2 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.0b3-py3-none-any.whl
Algorithm Hash digest
SHA256 779b52cd91b1536fbe99d998632d31cb04eb50c1ff2eaa5a13fb455586a840a8
MD5 a2f214cf38f31371135cce67a6b9ae33
BLAKE2b-256 67b8bf9fe7cad1b63e3c38336deda72784a76f3f16635add53a8a250ec5f71df

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