ReqIF improvements, documentation of custom grammars, removal of legacy SPECIAL_FIELDS

What's Changed

• add Dockerfile for dockerization of strictdoc by @fkromer in #572
• add snap package by @fkromer in #574
• add docker usage info to documentation by @fkromer in #575
• Create CONTRIBUTING.md by @stanislaw in #576
• backend/reqif: make export/import follow some of the ReqIF guideline by @stanislaw in #585
• cli: add "version" command by @fkromer in #584
• backend/reqif: convert SDoc's COMMENT to ReqIF's NOTES and vice versa by @stanislaw in #586
• backend/sdoc: support fields with empty string values by @stanislaw in #593
• backend/sdoc and export/html: remove legacy BODY field by @stanislaw in #594
• backend/sdoc: support multiline fields with empty string values by @stanislaw in #595
• reqif: upgrade to 0.0.13 by @stanislaw in #596
• backend/reqif: export REQ-IF-HEADER with basic info about strictdoc by @stanislaw in #599
• backend/reqif: export SPECIFICATION-TYPE by @stanislaw in #600
• minor: replace all FREE_TEXT with FREETEXT by @BenGardiner in #603
• reqif: minor cleanup using .create() methods by @stanislaw in #605
• Code climate: archive the unused FmStudio code by @stanislaw in #606
• grammar: remove SPECIAL_FIELDS support from everywhere by @stanislaw in #607
• DocumentFinder: do not look for .sdoc files in the output/ folder by @stanislaw in #608
• docs: remove sandbox, introduce examples by @stanislaw in #609
• docs: document experimental requirements to source code traceability by @stanislaw in #610
• grammar and *: remove obsolete BODY and last artefacts of SPECIAL_FIELDS by @stanislaw in #611
• Code climate: remove archive/ for good by @stanislaw in #612
• Bump version to 0.0.19 by @stanislaw in #613

New Contributors

• @fkromer made their first contribution in #572
• @BenGardiner made their first contribution in #603

Full Changelog: 0.0.18...0.0.19

Intermediate release with initial ReqIF export/import capability

What's Changed

• CI: Enable Python 3.10 by @stanislaw in #508
• export/html-standalone: embed favicon by @stanislaw in #509
• export/html: reuse markup renderer to improve performance by @stanislaw in #511
• Code climate: a few missing init.py's to prepare for mypy by @stanislaw in #512
• Code climate: fix more pylint warnings by @stanislaw in #513
• traceability: fix calculation of locations when there are empty source lines by @stanislaw in #516
• Code climate: increase pylint limit again by @stanislaw in #517
• backend/source_file_syntax: simplify handling of the source lines by @stanislaw in #518
• grammar: improve handling of the multiline fields by @stanislaw in #519
• grammar: introduce [DOCUMENT].OPTIONS.AUTO_LEVELS by @stanislaw in #522
• import/reqif: from ReqIF to SDoc: initial implementation by @stanislaw in #521
• tasks: make pylint always be 10.0 for whitelisted fixed warnings by @stanislaw in #523
• Code climate: pylint: fix C1801 by @stanislaw in #524
• reqif: switch to selecting parser via an argument by @stanislaw in #525
• grammar and export/html: document markup option: HTML fragment writer by @stanislaw in #526
• import/reqif: Doors parser: parse tables stored as XHTML fields by @stanislaw in #527
• tests/unit: group stage1 parser-related tests by @stanislaw in #528
• import/reqif: parsing SpecRelation by @stanislaw in #530
• Code climate: fix Pylint: W0703, W0231 by @stanislaw in #531
• Code climate: fix Pylint: W0235, W0613 by @stanislaw in #532
• Code climate: Fix strict Pylint warnings for newly added modules by @stanislaw in #533
• import/reqif: native parser: parse custom fields by @stanislaw in #534
• Code climate: introduce basic mypy checking by @stanislaw in #535
• Code climate: mypy: make explicit which checks are enabled/disabled by @stanislaw in #536
• imports/reqif: Doors parser: initial parsing of images by @stanislaw in #537
• Code climate: fix several Pylint warnings by @stanislaw in #538
• import/reqif: Doors parser: parse bullet point-based subreqs by @stanislaw in #539
• imports/reqif: REQIF.SPECIFICATION.LONG-NAME -> SDOC.DOCUMENT.TITLE by @stanislaw in #540
• Code climate: fix all remaining major Pylint warnings by @stanislaw in #541
• Code climate: set Pylint target to 10.0 by @stanislaw in #542
• Code climate: introduce code coverage calculation by @stanislaw in #543
• backend/dsl: extract parsing processing to a separate class by @stanislaw in #547
• backend/dsl/writer: print based on type information, not hardcoded by @stanislaw in #548
• backend/dsl: switch to dynamic fields, with validation by @stanislaw in #549
• backend/dsl: support grammar fields: SingleChoice, MultipleChoice, Tag by @stanislaw in #550
• backend/dsl: more 'passthrough' tests for new types by @stanislaw in #551
• backend/dsl: support custom grammars and a basic type system by @stanislaw in #552
• tasks: remove obsolete second Pylint task by @stanislaw in #553
• Poetry: integrate reqif 0.0.1 by @stanislaw in #554
• reqif: first integration and ReqIF-SDoc end-to-end tests by @stanislaw in #555
• cli: dump-grammar command by @stanislaw in #556
• reqif/export: case when requirement is lower-level than previous section by @stanislaw in #557
• reqif/export: case when requirement is lower-level than previous section by @stanislaw in #558
• reqif: native: export/import roundtrip for SECTION.FREETEXT by @stanislaw in #559
• reqif: native: export/import roundtrip for multiline requirement fields by @stanislaw in #560
• docs: document ReqIF export/import workflows by @stanislaw in #565
• docs: fix links to the grammar.py and regenerate the docs by @stanislaw in #567
• Bump version to 0.0.18 by @stanislaw in #568

Full Changelog: 0.0.17...0.0.18

Support SDoc files with UTF-8 content, improvements of the incremental generation

What's Changed

• Create codeql-analysis.yml by @stanislaw in #485
• CI: Remove Ubuntu 16 workflow by @stanislaw in #488
• Poetry: update FileCheck by @stanislaw in #487
• tests/integration: enable back the HTML markup test by @stanislaw in #486
• traceability: switch to UTF-8 when reading and generating source files by @stanislaw in #489
• traceability: [nosdoc] directive to disable requirements search in source files by @stanislaw in #490
• docs: regenerate rst using the new file name convention by @stanislaw in #492
• docs: add "Contact developers" by @stanislaw in #493
• html, html-standalone, rst: fix UTF8 when stdout + reading and writing files by @stanislaw in #495
• traceability_index: extract file traceability container to a separate file by @stanislaw in #496
• export/html: regenerate all child docs if the parent doc changes by @stanislaw in #497
• docs: add "Document archetypes" draft requirement by @stanislaw in #499
• export: print how long it takes to collect the traceability info by @stanislaw in #500
• export/html: regenerate all parent docs if the child doc changes by @stanislaw in #501
• export/html: regenerate all parent docs if new child is found by @Relasym in #503
• tests/integration: use sandbox approach to fix an incr. generation test by @stanislaw in #504
• Bump version to 0.0.17 by @stanislaw in #506
• CI: fix broken Poetry installation when Python 3.10 is used by @stanislaw in #507

New Contributors

• @Relasym made their first contribution in #503

Full Changelog: 0.0.16...0.0.17

export/html: Project title option and "Requirements Coverage" view

Merge pull request #484 from strictdoc-project/bump-version

docs: switch back to guzzle_sphinx_theme for better support by Read the Docs

HTML export: Several UI improvements in the table and traceability screens.

Highlights:

• Improvements in the table view: meta information's fields are now visually embedded into the table cell.
  • The meta table is also improved on the TR screen.
• Fixed old development artifact: export/html: stop decapitalizing custom field name in the meta table.
• grammar: document-level option to specify markup (RST and Text for now).

Small release to fix the missing Pygments dependency

Source of the change: #463

Several UI improvements and fixes in the HTML export

Key highlights:

• Several fixes of the table and deep traceability screens. Due to the similarities, the Traceability and Deep Traceability screens will likely be merged in the near future.
• The Requirements-to-Files traceability UI is receiving further tweaks and improvements. It is approaching a releasable state. The feature is being tested against StrictDoc's own documentation
• Several fixes of the edge cases related to the file search (finding .sdoc files and _assets folders).

Mathjax support and source file traceability groundwork

Selected highlights:

• Mathjax support (--enable-mathjax)
• Requirements to source files traceability is getting to a releasable state.
• export/rst: catch and report RST-to-HTML conversion warnings #423 (stanislaw)
• StrictDoc now detects cycles: A validation error is shown if requirements reference each other.

HTML export: Support copying assets in the single SDoc case

• export/html: fix the generation of assets for a single file case

Better error handling for child processes and a few fixes and improvements

Notable changes:

• Parallelizer: switch from Pool to Process: handle exists and exceptions
• export/html: pan-with-space.js: fix scrolling
• export/rst: preserve original file name instead of using document title
• grammar: supporing Document number and Document version (groundwork)