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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: nics-3.0.0b8.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.0b8.tar.gz
Algorithm Hash digest
SHA256 c973729325e8aa6bb09f2fb9de49f635a5b34076ec8ae81e73cac8783b3cb7c2
MD5 83f69427b6d7378ae1113951b482d12d
BLAKE2b-256 f1d9d3c6315c313c7c0ed4f45f0f4f9844444f48f7b841135845d4567de1c12e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: nics-3.0.0b8-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.0b8-py3-none-any.whl
Algorithm Hash digest
SHA256 a0086c672a7562d311b77bc65ca79d3b20560a68c9e8ce68e967b4b24c10d0fe
MD5 7abcb8083ec5b89cd0d177442f33a51a
BLAKE2b-256 42f0b41445ae88da19805e044ade8b1558b8e1c7ffd48d212f66707e71bc773a

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