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.21.1.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.21.1-py3-none-any.whl (6.3 MB view details)

Uploaded Python 3

File details

Details for the file strictdoc-0.21.1.tar.gz.

File metadata

  • Download URL: strictdoc-0.21.1.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.21.1.tar.gz
Algorithm Hash digest
SHA256 72a4f8e49aff347396beca5361e12fbf7ab51861ea1e0e25079544ddd5489db7
MD5 25d46774b052232eb4e63a3929ba5fa4
BLAKE2b-256 c9117b1e1d7995e57e6414b3faed319180c803705e8d5c0cb54bc23f8298f7c6

See more details on using hashes here.

File details

Details for the file strictdoc-0.21.1-py3-none-any.whl.

File metadata

  • Download URL: strictdoc-0.21.1-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.21.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1031904bda9f7ba22a4862ff3b574c08c636e145eec290d7ccbe33cd6dd97c94
MD5 d63954871ea90dcc942416d315d6e1f1
BLAKE2b-256 2c10c400da7f0604818e3eaa9cf74777deac226ffc98b4d896b657445674fa38

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