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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: nics-3.0.0b7.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.0b7.tar.gz
Algorithm Hash digest
SHA256 d8c9d007b0cb7cd54e0a1e1066fe96967ea02c965a11c2c54d2ad9d935225853
MD5 bbb8b4acb47113eddd3f525a7ddccf76
BLAKE2b-256 2d4afae158724afcff99e57bf8a6f2e580912c6058d4c3098d7c4b883139ace8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nics-3.0.0b7-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.0b7-py3-none-any.whl
Algorithm Hash digest
SHA256 0c7fb0c4cc57d0ca53b5a234ce06e1ee654ffd6efb2f899578fa48324a220d54
MD5 9c09dff3e1d1d492da8cb47c160bff6f
BLAKE2b-256 819fbcaed393f9fcf596bb05079d86d2193b08769dcd02b7b7fd9233b146f44b

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