Releases: strictdoc-project/strictdoc
Releases · strictdoc-project/strictdoc
First release of Web interface, numerous UI improvements, ReqIF improvements
What's Changed
- UI: Implement the new layout and behavior changes for the TOC by @mettta in #813
- server, UI: editing multiple requirement comments by @stanislaw in #814
- core: project-level TOML config file by @stanislaw in #815
- UI: Dedicated controller for collapsible Table of Contents by @mettta in #816
- server, UI: editing document config: TITLE and VERSION by @stanislaw in #817
- grammar, models: remove RequirementComment by @stanislaw in #819
- sdoc/models: requirement: remove title, statement, and rationale setters by @stanislaw in #820
- sdoc/models: requirement: title -> reserved_title by @stanislaw in #821
- sdoc/models: requirement: remove @uid, @status, @Level setters by @stanislaw in #822
- models: requirement: remove #tags setter by @stanislaw in #824
- server, UI: editing document grammar by @stanislaw in #825
- export/html: switch to Python helper for rendering static URLs by @stanislaw in #827
- export/html: group JS controllers in a dedicated folder by @stanislaw in #828
- export/html: remove JQuery by @stanislaw in #829
- UI: refactor CSS by @mettta in #832
- server: fix editing of the grammar fields by @stanislaw in #833
- docs: FAQ: SDoc markup and StrictDoc tutorial by @stanislaw in #834
- tasks: adapt PyInstaller to support "strictdoc server" command by @stanislaw in #838
- tests/integration: run strictdoc without any args to attest the PyInstaller bug by @stanislaw in #839
- UI: Add dropdown menu on nodes by @mettta in #840
- tasks: Environment class to encapsulate all compile-time information by @stanislaw in #841
- UI: add Empty Document placeholder and the corresponding test by @mettta in #843
- Remove Nuitka from the development dependancies by @mettta in #844
- Tests/end2end: delete comments by @mettta in #845
- UI: update 'Empty Doc placeholder' template and related tests by @mettta in #846
- server, tests/end2end: run dev server and test servers on different ports by @stanislaw in #847
- Code climate: tests/end2end: remove debug screenshot lines by @stanislaw in #848
- Code climate: tests/end2end: adjust document tree tests to latest naming conventions by @stanislaw in #849
- server: validation: do not allow creating documents without .sdoc extension by @stanislaw in #850
- server, UI: editing table-based requirements by @stanislaw in #851
- traceability_index: refactoring work towards Web-editable parent links by @stanislaw in #852
- traceability_index: method to assign/unassign a requirement parent link by @stanislaw in #853
- server, UI: adding/deleting requirement's parent links by @stanislaw in #854
- server, UI: egse case when editing requirement (no UID) by @stanislaw in #855
- Code climate: tasks: add ruff linter by @stanislaw in #856
- Code climate: ruff: activate I group by @stanislaw in #857
- tasks, packaging: allow generating a Windows release under Linux via … by @RobertoBagnara in #836
- pyproject.toml: bump ReqIF version, change to >= by @stanislaw in #858
- reqif: import: skip DATE spec object attributes by @stanislaw in #859
- reqif: reqif-to-sdoc: remove the factory class to simplify further work by @stanislaw in #860
- reqif: improved handling of multi-value enum attributes. by @stanislaw in #862
- Ensure that multiprocessing.freeze_support() is called in a frozen application by @RobertoBagnara in #861
- CI: bring back the PyInstaller task on macOS by @stanislaw in #863
- reqif: introduce p11_polarion profile, parse the user-provided Polarion example by @stanislaw in #864
- reqif: p11_polarion: strip XHTML tags from xhtml:... namespace prefixes by @stanislaw in #865
- tests/integration: reqif/profiles/p11_polarion/02_escaping_symbols by @stanislaw in #866
- tests/integration/examples: add basic examples by @stanislaw in #867
- server: switch to port 5111 as less popular port by @stanislaw in #868
- server, UI: move editing of the free text into a document config section by @stanislaw in #869
- docs: FAQ: some numbers by @stanislaw in #874
- Finish handling of the grammar fields: moving up/down and deleting a new grammar field by @stanislaw in #873
- examples: move in tests/integration/examples, strip from itest files by @mettta in #875
- UI: fix line on the top of the source code page by @mettta in #876
- Source file traceability: fix edge case: Pygments ignore the first empty line in a file by @stanislaw in #878
- docs: requirements: remove composite requirements by @stanislaw in #881
- server, UI: Document tree: modal forms, test updates by @mettta in #883
- docs: User Guide: add a link to strictdoc-examples repository by @stanislaw in #886
- requirements coverage: hide under the traceability flag for now by @stanislaw in #887
- UI: update form/modal markup and CSS by @mettta in #889
- export/rst: fix edge case when rendering RST section titles by @stanislaw in #890
- docs: regenerate Read the Docs documentation by @stanislaw in #892
- server: update requirement: only regenerate the document's own SDoc file by @stanislaw in #894
- UI: update 'edit section/requirement' forms templates by @mettta in #896
- UI: forms: comment fields by @mettta in #897
- Code climate: upgrade link_health.py by @stanislaw in #898
- backend/sdoc_source_code: introduce the @SDoc keyword by @stanislaw in #899
- export/html: support linking requirements with Jinja files by @stanislaw in #900
- Code climate: fix all T201 errors by @stanislaw in #901
- Code climate: ruff: activate most of UP group by @stanislaw in #903
- Code climate: ruff: activate ERA by @stanislaw in #904
- UI:forms: edit grammar by @mettta in #905
- UI: forms: add a default field_name value for newly added fields by @mettta in #906
- UI: forms: update grammar fields by @mettta in #916
- docs: update Backlog by @stanislaw in #918
- docs: FAQ: document basic web server recommendations by @stanislaw in #919
- UI: forms: Requirement parent link by @mettta in #921
- docs: regenerate Read the Docs documentation by @stanislaw in #920
- UI: forms: components/form/field by @mettt...
Minor bugfix release
What's Changed
- Code climate: extend linting by flake8 and pylint to tests/* by @stanislaw in #805
- server, UI: requirement form is rendered from all grammar fields by @stanislaw in #806
- UI: pan-with-space.js: Use #pan-with-space instead of class by @mettta in #807
- docs: link health: add Bugseng article to exceptions by @stanislaw in #808
- export/html: do not display "Export to ReqIF" in the static export by @stanislaw in #809
- Bump version to 0.0.32 by @stanislaw in #810
Full Changelog: 0.0.31...0.0.32
Fixes in the release system
What's Changed
- Code climate: introduce helpers/auto_described to print objects by @stanislaw in #796
- backend/excel/export: Support Excel Export of custom grammar fields by @GGBeer in #797
- server: editing requirement's rationale by @stanislaw in #799
- server: editing requirement's UID by @stanislaw in #800
- server: clean up the main controller using the new API by @stanislaw in #801
- server: main_router: merge in complete main_controller by @stanislaw in #802
- tasks, packaging: switch to pyproject.toml, remove setup.py by @stanislaw in #804
Full Changelog: 0.0.30...0.0.31
Experimental initial web server, export custom fields to RST, ReqIF parsing improvements
What's Changed
- backend/sdoc/grammar: Add optional DocumentConfig CLASSIFICATION field by @GGBeer in #759
- server: initial Web-based GUI (editing doc tree and documents) by @stanislaw in #758
- UI: give the connection status message a more solid look by @mettta in #760
- docs: renumber the documents by @stanislaw in #761
- UI: Filtering text in single line contenteditable fields by @mettta in #762
- docs: updates related to the new server work by @stanislaw in #763
- backend/sdoc/grammar: Add GRAMMAR for REFS-TypeValue variant by @GGBeer in #754
- server: trim all form fields, remove trailing whitespace by @stanislaw in #765
- docs: update contributing and development guides by @stanislaw in #766
- server: read both single- and multi-line requirement statements by @stanislaw in #767
- UI: Make form fields have monospace font by @mettta in #769
- CI: try Selenium tests on macOS by @stanislaw in #770
- backend/rst: handle SEVERE errors through the friendlier interface by @stanislaw in #771
- tests/integration: try a Windows-friendlier diff command by @stanislaw in #772
- docs:strictdoc_01_user_guide UGuide updates/restructuring by @GGBeer in #768
- Code climate: Do not rely on SD working dirname in ConfTest by @GGBeer in #773
- server: basic importing and exporting ReqIF by @stanislaw in #776
- backend/reqif: exporting document's free text by @stanislaw in #778
- export/rst: switch to Jinja template for rendering requirement to RST by @stanislaw in #780
- export/rst: switch to Jinja template for rendering requirement to RST (take 2) by @stanislaw in #781
- docs: Contributing: How can I help? by @stanislaw in #783
- server: escape multi-line text when rendering edit forms (requirement, section) by @stanislaw in #784
- server: fix zombie worker processes issue when Selenium timeouts by @stanislaw in #786
- server: exporting and importing complete document tree by @stanislaw in #787
- export, rst: add custom grammar fields into jinja2 rendering by @BenGardiner in #788
- backend, sdoc, rst: remove trailing newlines by multistring fields by @stanislaw in #790
- backend/sdoc/grammar: Refactoring REFS ParentReqReference, FileReference by @GGBeer in #791
- backend/sdoc/grammar: Add REFS-BibReference by @GGBeer in #792
- backend/sdoc: fix the edge case when rstripping the multi-line fields by @stanislaw in #793
- backend/reqif: update to the latest API by @stanislaw in #794
- Bump version to 0.0.30 by @stanislaw in #795
Full Changelog: 0.0.29...0.0.30
Minor bugfix release
What's Changed
- export/rst: fix case when requirements do not have titles by @stanislaw in #756
- Bump version to 0.0.29 by @stanislaw in #757
Full Changelog: 0.0.28...0.0.29
Pip setup.py file bugfix release
What's Changed
- Regenerate CHANGELOG by @stanislaw in #747
- docs: minor updates to the contribution guideline by @stanislaw in #750
- Use constants instead of hardcoded Requirement-Fieldname strings. by @GGBeer in #748
- Trivial refactoring of has/get_children_requirements and has/get_pare… by @GGBeer in #749
- setup.py: fix issue with packaging requirements.txt file by @stanislaw in #752
New Contributors
Full Changelog: 0.0.27...0.0.28
Python 3.11 support
What's Changed
- Use raw directive for tex instead of double escaping by @lochsh in #722
- docs: regenerate Read the Docs by @stanislaw in #724
- requirements: remove <3.0 limitation on jinja2 by @stanislaw in #726
- cli: minor improvement in strictdoc's root path handling by @stanislaw in #727
- export_action: refactoring: no need to pass an extra path argument by @stanislaw in #729
- export_action: refactoring: clean up ExportCommandConfig by @stanislaw in #730
- traceability_index: refactoring: bring in all data from the generators by @stanislaw in #731
- traceability_index: refactoring: split building index and generating docs by @stanislaw in #732
- Code climate: html_generator: remove dead code by @stanislaw in #733
- CI: Fix Python 3.10 and 3.11 issues by @stanislaw in #734
- CI: try 3.11 on macOS and Linux jobs by @stanislaw in #735
- tests/integration: exercise the fix of incremental copying of assets by @stanislaw in #736
- models/document: remove deprecated "NAME:" field by @stanislaw in #737
- traceability_index: annotate variables with numbers for readability by @stanislaw in #738
- traceability_index: remove no longer used code: max depth count by @stanislaw in #739
- CI: remove last job with Python 3.6 by @stanislaw in #743
- tasks: enable installation using PyInstaller by @stanislaw in #744
- docs: update Discord link by @stanislaw in #745
- Bump version to 0.0.27 by @stanislaw in #746
Full Changelog: 0.0.26...0.0.27
Excel-like Table view, document meta information, support requirements without titles
What's Changed
- grammar: New option: REQUIREMENT_HAS_TITLE by @stanislaw in #695
- grammar: REQUIREMENT_HAS_TITLE -> REQUIREMENT_IN_TOC by @stanislaw in #696
- Code climate: fix cyclic import in strictdoc.backend.sdoc.processor by @stanislaw in #697
- bugfix: AttributeError: 'NoneType' object has no attribute 'required' by @stanislaw in #699
- tasks: experimental "watch" task by @stanislaw in #700
- tasks: switch to python3 everywhere for now by @stanislaw in #702
- export/HTML: UI: the title is no longer a required field by @mettta in #701
- backend/sdoc: fix handling of LEVEL: None for composite requirements by @stanislaw in #703
- tasks: fix dead links task by @stanislaw in #704
- export/HTML: UI: fix grid in .table-view > .requirement_meta by @mettta in #705
- grammar: document_config: expose has_meta() by @stanislaw in #706
- export/HTML: add document META to document view by @mettta in #707
- docs: move CONTRIBUTING to .sdoc by @stanislaw in #708
- export/HTML: add document META to table view by @mettta in #709
- docs: extract F.A.Q. to a separate document by @stanislaw in #712
- docs: FAQ: add FRET and blog posts about StrictDoc by @stanislaw in #714
- UI: ultimate table view by @mettta in #715
- export/HTML: Fix white stripe above the table in table-view by @mettta in #716
- export/HTML: Isolate CSS for .content-view-table by @mettta in #717
- export/HTML: Fixing left panel (TOC) behavior by @mettta in #718
- export/HTML: fixing white background cutoff in the table view by @mettta in #719
- docs: regenerate Read the Docs by @stanislaw in #720
- Bump version to 0.0.26 by @stanislaw in #721
Full Changelog: 0.0.25...0.0.26
UI improvements and steps towards a more complete Windows support
What's Changed
- Code climate: improve css fix html rendering for ordered list by @gioboske in #654
- CI: set up correct dependencies for periodic checking of dead links by @stanislaw in #656
- docs: split the documents: User Manual, Requirements and Backlog by @stanislaw in #657
- export/html: support sections without a level by @stanislaw in #651
- tasks: fix dead links task by @stanislaw in #658
- requirements.development.txt: relax all dependencies to >= by @stanislaw in #659
- requirements.txt: relax all dependencies to >= by @stanislaw in #660
- docs: extract goals to the development plan draft by @stanislaw in #661
- tasks: reset PATH when running from virtual environments by @stanislaw in #663
- tasks: do not reset the PATH when running sphinx task by @stanislaw in #664
- feature: import excel by @BenGardiner in #662
- tasks: stop using @task for cleaning the itest artifacts by @stanislaw in #666
- backend/excel: keep import and export together by @stanislaw in #667
- requirements.txt: constraint most of the deps to the same major version by @stanislaw in #668
- Code climate: mypy: enable --strict and disable remaining checks by @stanislaw in #669
- Code climate: mypy: fix the "assignment" errors by @stanislaw in #670
- Code climate: try * to enforce named parameters by @stanislaw in #671
- Code climate: tests/integration: prepare test folders by @stanislaw in #672
- excel/import: optional title for imported documents by @BenGardiner in #673
- docs: small update in the dev plan by @stanislaw in #674
- developer/design: add a sketch (Affinity Design) by @stanislaw in #676
- HTML export improvements by @BenGardiner in #677
- traceability: source_files_finder: ignored_dirs argument and unit test by @stanislaw in #678
- traceability: simplify handling of source file paths by @stanislaw in #679
- export/html: table-based requirement template by @stanislaw in #680
- tasks: fix the "The command line is too long." issue on Windows by @stanislaw in #682
- tasks: check_environment: un-hardcode python3 because it fails on Windows by @stanislaw in #683
- export/html: link_renderer: always print forward slashes (Windows) by @stanislaw in #684
- tasks and tests/integration: portable clean, %cat, and %diff by @stanislaw in #685
- tests/integration: Python version of cat to make it portable by @stanislaw in #686
- tests/integration: Python version of 'touch' and 'mkdir' to make them portable by @stanislaw in #687
- tests/integration: Python version of 'cp' and 'rm' to make them portable by @stanislaw in #688
- export/html: integration test for UTF8 symbols in SDoc by @stanislaw in #689
- tests/integration: improve rm.py by @stanislaw in #690
- tasks: on Windows: detect if Bash is available by @stanislaw in #691
- file traceability: improve handling of Windows-style paths by @stanislaw in #692
- tests/integration: move away from a grep-based test by @stanislaw in #693
- docs: update documentation, introduce design document by @stanislaw in #694
New Contributors
Full Changelog: 0.0.23...0.0.25
New feature "SDoc fragments from files" and improvements in the infrastructure
What's Changed
- tasks: tests-unit: allow running in focused mode by @stanislaw in #628
- Code climate: remove unused code "ng_sections" by @stanislaw in #631
- new feature FRAGMENT_FROM_FILE by @BenGardiner in #629
- requirement: use multiline value for None values in meta fields by @BenGardiner in #633
- tasks: reduce repetition of "one_line_command" by @stanislaw in #635
- tasks: fix broken mypy task by @stanislaw in #636
- Poetry: upgrade and update requirements.txt by @stanislaw in #637
- link_health: check dead links in strict.sdoc by @stanislaw in #638
- tasks: replace Poetry with plain setup.py by @stanislaw in #640
- tasks: simplify setting up dependencies by @stanislaw in #642
- Bump version to 0.0.22a1 by @stanislaw in #643
- setup.py: include requirements.txt to the egg by @stanislaw in #644
- tasks: "release" task by @stanislaw in #645
- tasks: make the venv types explicit by @stanislaw in #646
- CI: daily integration test by @stanislaw in #647
- docs: document the new development workflow without Poetry by @stanislaw in #648
- docs: update Docker instructions by @stanislaw in #649
Full Changelog: 0.0.21...0.0.23
What's Changed
- setup.py: fix copying of the HTML files by @stanislaw in #655
Full Changelog: 0.0.21...0.0.23
What's Changed
- setup.py: fix copying of the HTML files by @stanislaw in #655
Full Changelog: 0.0.22...0.0.23