Skip to main content

StrictDoc is open-source software for technical documentation and requirements management.

Project description

StrictDoc

StrictDoc is open-source software for technical documentation and requirements management.

Documentation

The main StrictDoc documentation is hosted on Read the Docs:

The documentation is hosted on Read the Docs: StrictDoc documentation.

For a quick visual overview, see the StrictDoc project slide deck.

Installation

StrictDoc requires Python 3.10 or newer.

pip install strictdoc

See the StrictDoc user guide section of the Read the Docs site for more details.

Quick start

Create a small hello_world.sdoc file:

[DOCUMENT]
TITLE: StrictDoc

[REQUIREMENT]
UID: SDOC-HIGH-REQS-MANAGEMENT
TITLE: Requirements management
STATEMENT: StrictDoc shall enable requirements management.

Export it to static HTML:

strictdoc export .

Or run the local web server:

strictdoc server .

StrictDoc starts the server on http://127.0.0.1:5111 by default.

Project links

License

StrictDoc is licensed under the Apache License 2.0. See LICENSE for details.

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

strictdoc-0.22.0a1.tar.gz (6.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

strictdoc-0.22.0a1-py3-none-any.whl (6.3 MB view details)

Uploaded Python 3

File details

Details for the file strictdoc-0.22.0a1.tar.gz.

File metadata

  • Download URL: strictdoc-0.22.0a1.tar.gz
  • Upload date:
  • Size: 6.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for strictdoc-0.22.0a1.tar.gz
Algorithm Hash digest
SHA256 65df3c096de9b2e0cc97f0161ccf8e8fd9d499a3a1b13c81de7acb6601b89742
MD5 165824b958111157903f8d99e9f8b3cc
BLAKE2b-256 02312f3da11ab3ce710ea2933e693aeefb60e2742ab3d002b2f043a0a76a90a6

See more details on using hashes here.

File details

Details for the file strictdoc-0.22.0a1-py3-none-any.whl.

File metadata

  • Download URL: strictdoc-0.22.0a1-py3-none-any.whl
  • Upload date:
  • Size: 6.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for strictdoc-0.22.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 1035e56c94107b80cf795ca5dfde04efede12806bbca730100a76d38a4b99e32
MD5 e2b04db49913a48b0833ea44e0c4f4c7
BLAKE2b-256 fa2d184c4d32068d52ea242a7cb1673034efd2413ee101c55c1167994cf8be36

See more details on using hashes here.

Supported by

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