Skip to content

Latest commit

 

History

History
2348 lines (1981 loc) · 280 KB

CHANGELOG.md

File metadata and controls

2348 lines (1981 loc) · 280 KB

Changelog

0.0.59 (2024-10-13)

Full Changelog

Closed issues:

  • CUSTOM GRAMMAR links issues #1928
  • LINKs: Anchors with IDs containing whitespace are not referrable in exported HTML #1916
  • HTML2PDF: Combine all documents into one PDF #1914
  • Export: move the --view option from the passthrough to the export command #1913
  • LINKs: Unexpected output / crash if appending "s" to [LINK:] for plural #1907
  • LINKs: Exception when linking to anchor in another sdoc file #1905
  • [LINK: <uid>] does not allow to express all valid UIDs #1897
  • RST export: LINKs from requirements and other nodes: Resolve and export them correctly #1888
  • 2024-Q2: Code climate #1770
  • 2024-Q2: Documentation train #1756
  • UI: Diff screen: Handle corner cases when calculating traceability back in project Git history #1707

Merged pull requests:

0.0.58 (2024-06-25)

Full Changelog

Closed issues:

  • manage auto-uid: UID field REQUIRED True leads to an error #1896
  • Epic: TEXT nodes and FREETEXT-TEXT migration #1864
  • Feature: [LINK] from/to a Requirement or other nodes: The web UI implementation. #1839
  • Extend GUI to support adding FREETEXT blocks #1766
  • Issue with Mixing FREETEXT and REQUIREMENT in .sdoc Files #1518

Merged pull requests:

0.0.57 (2024-06-23)

Full Changelog

Fixed bugs:

  • AssertionError when updating the relation for a requirement #1856

Closed issues:

  • TRM: filter out text nodes. #1892
  • TEXT: Double-check the rendering of LEVELs for missing titles and LEVEL/None. #1891
  • Add child requirement -> Add child node. #1884
  • Bug: UI requirement validation fails if optional SingleChoice field is not entered #1876
  • Error message "document MID is not unique" missing clear indication of offending requirement and document #1865
  • DIFF: render text nodes with T #1863
  • UI bug: Rendering of “MARKUP: HTML” elements #1858
  • Delete section: Add validations to the confirmation window #1556
  • Form validation for grammar fields that are marked as required #1022

Merged pull requests:

  • UI: TRM: Exclude text nodes from the list #1893 (stanislaw)
  • backend/sdoc: writer: --free-text-to-text for SECTIONs #1886 (stanislaw)
  • export/html: update hints on node control #1885 (mettta)
  • docs: User Guide: describe FREETEXT-TEXT migration path #1883 (stanislaw)
  • cli: passthrough: --free-text-to-text option to migrate FREETEXT->TEXT #1882 (stanislaw)
  • docs: User Guide: implement FREETEXT-TEXT changes #1881 (stanislaw)
  • docs: update release notes #1880 (stanislaw)
  • UI: Do not auto-generate UID for TEXT nodes for now #1879 (stanislaw)
  • UI: Support MultipleChoice in requirement form #1878 (haxtibal)
  • UI: Node form validation: allow empty SingleChoice fields when REQUIRED is False #1877 (stanislaw)
  • docs: prepare the release notes for FREETEXT-TEXT migration #1875 (stanislaw)
  • tasks: remove pylint and flake8, create aliases for most common tasks #1874 (stanislaw)
  • Remove Graphviz and DocumentDotGenerator #1873 (stanislaw)
  • UI: Ensure that documents with HTML markup get rendered correctly when edited #1872 (stanislaw)
  • UI: Edit grammar element relations form: TEXT node can have no relations #1871 (stanislaw)
  • Bump version to 0.0.57a2 #1870 (stanislaw)
  • Node machine identifiers (MID): improve uniqueness validation message #1869 (stanislaw)
  • backend/sdoc: Document: remove .free_texts #1868 (stanislaw)
  • UI: Diff screen: Ensure escaping of requirement fields #1867 (stanislaw)
  • UI: HTML markup changes and adjust remaining tests, removing dependencies on FREETEXT #1866 (stanislaw)
  • UI: Create/Update/Delete node: Implement all existing cases related to LINK/ANCHOR #1862 (stanislaw)
  • UI: Delete node: incoming links to anchors validation #1859 (stanislaw)
  • html: Rename "parent relations" to "parents" and "child relations" to "children" #1855 (haxtibal)
  • UI: Create node: parse, validate, and render LINK/ANCHOR #1854 (stanislaw)
  • UI: Create node: parse and validate LINK/ANCHOR #1852 (stanislaw)
  • backend/reqif: when --reqif-multiline-is-xhtml, generate FREETEXT spec type attribute as XHTML #1851 (stanislaw)
  • HTML2PDF: Fail early if feature is not enabled #1850 (haxtibal)
  • UI: Delete section/node: Add validations to the confirmation window #1849 (stanislaw)
  • export/html and UI: Rendering [TEXT] node, basic end2end tests #1848 (stanislaw)
  • docs: release notes for 0.0.56 #1847 (stanislaw)
  • Code climate: tests/end2end: anchors -> LINK_AND_ANCHOR #1846 (stanislaw)
  • UI: requirement_form_object: improve handling of multiline field boundary #1845 (stanislaw)
  • export/html, LINK: referenced node shows an anchor link if referenced with [LINK] #1844 (stanislaw)
  • Feature: [LINK] from all fields of Requirement or other nodes #1843 (stanislaw)
  • Code climate: Introduce THIS_TEST_FOLDER to increase the portability of most itests #1842 (stanislaw)
  • Code climate: remove useless __init__.py files #1840 (stanislaw)
  • tests/integration: add an RST code block test just in case #1838 (stanislaw)
  • backend/sdoc: introduce [TEXT] node #1837 (stanislaw)
  • Feature: LINK to requirements and custom nodes (static export only for now) #1835 (haxtibal)
  • backend/reqif: --reqif-multiline-is-html: extend the integration test #1834 (stanislaw)
  • backend/sdoc: grammar: teach SDocNodeField to parse FreeText parts #1833 (stanislaw)
  • backend/sdoc: instantiate doc/grammar meta models at start time #1832 (stanislaw)
  • backend/sdoc: validate grammar from file like a normal grammar #1831 (stanislaw)
  • UI: Form validation: SingleChoice and REQUIRED fields #1829 (stanislaw)

0.0.56 (2024-05-20)

Full Changelog

Closed issues:

  • Custom grammar without STATEMENT field causes exception #1823
  • RFC: Assessing impact of a clarified requirement? #1806
  • Broken command manage auto-uid / Import sgra content into file when using manage auto uid #1804
  • ReqIF: Export/import grammar types / SPEC-TYPEs #1801
  • Rename globally: References -> Relations #1042

Merged pull requests:

  • Bump version to 0.0.56a3 #1828 (stanislaw)
  • backend/sdoc: allow using "DESCRIPTION" or "CONTENT" field instead of "STATEMENT" #1827 (stanislaw)
  • Code climate: backend/sdoc: free_text: fix all mypy issues #1826 (stanislaw)
  • cli: remove the legacy argument: --experimental-enable-file-traceability #1825 (stanislaw)
  • backend/sdoc: remove the last few occurences of REFS #1824 (stanislaw)
  • backend/sdoc: SDocField: improve handling of single/multiline fields #1822 (stanislaw)
  • backend/sdoc: finish migration, removing all instances of REFS #1821 (stanislaw)
  • pyproject.toml: update python-datauri #1820 (DomenicP)
  • Code climate: strictdoc/backend/sdoc/models/node.py: fix no-untyped-call and no-untyped-def mypy issues #1819 (stanislaw)
  • Code climate: strictdoc/helpers/parallelizer.py: fix all mypy issues #1818 (stanislaw)
  • Code climate: strictdoc/cli/main.py: fix all mypy issues #1817 (stanislaw)
  • html2pdf: specify UTF-8 encoding when writing HTML file #1816 (stanislaw)
  • Bump version to 0.0.56a1 #1815 (stanislaw)
  • Code climate: parallelizer: fix all "no-untyped-call" mypy issues #1814 (stanislaw)
  • Code climate: document_finder: fix all "no-untyped-def" mypy issues #1813 (stanislaw)
  • Code climate: document_finder: fix all "no-untyped-call" mypy issues #1812 (stanislaw)
  • backend/reqif: further tweaks for multi-document ReqIF bundles #1811 (stanislaw)
  • Experimental features: Nestor requirements graph visualizer #1810 (stanislaw)
  • backend/reqif: exporting grammar types #1809 (stanislaw)
  • Composable documents: edge case when a single document path is provided for a document that depends on other documents #1807 (stanislaw)
  • tests/integration: add several tests to ensure auto-uid / composable documents intersection #1805 (stanislaw)
  • Bump version to 0.0.55 #1803 (stanislaw)

0.0.55 (2024-04-28)

Full Changelog

Closed issues:

  • Reusing glossary entry across multiple documents in same doctree? #1779
  • Composable documents: Enable correct resolution of asset paths when included documents are stored in arbitrarily nested folders #1777

Merged pull requests:

  • backend/reqif: --reqif-import-markup option to specify HTML or other options when importing #1802 (stanislaw)
  • backend/reqif: --reqif-enable-mid option to allow bi-directional IDENTIFIER-MID mapping #1800 (stanislaw)
  • pickle_cache: reuse between Document and DocumentGrammar for caching both #1799 (stanislaw)
  • pickle: catch AttributeErrors on schema changes, raise AssertionError otherwise #1798 (stanislaw)
  • backend/reqif: update to the latest ReqIF library #1797 (stanislaw)
  • backend/reqif: fix the XHTML namespace #1796 (stanislaw)
  • backend/reqif: reqif_to_sdoc_converter.py: fix no-untyped-call issues #1795 (stanislaw)
  • backend/reqif: reqif_to_sdoc_converter.py: fix arg-type issues #1794 (stanislaw)
  • CI: drop Python 3.7 from macOS jobs #1793 (stanislaw)
  • backend/reqif: export: --multiline-is-xhtml option #1792 (stanislaw)
  • backend/reqif: reqif_to_sdoc: simplify iteration further #1791 (stanislaw)
  • backend/reqif: reqif_to_sdoc: simplify iteration #1789 (stanislaw)
  • Code climate: sdoc/models/section: remove unused code #1787 (stanislaw)
  • Code climate: sdoc/models/document: fix no-untyped-def #1786 (stanislaw)
  • Code climate: sdoc/models/document: fix no-untyped-call #1785 (stanislaw)
  • Code climate: enable remaining mypy checks #1784 (stanislaw)
  • Code climate: enable attr-defined and no-any-return check #1783 (stanislaw)
  • Code climate: fix mypy version guard #1782 (stanislaw)
  • Bump version to 0.0.55a1 #1781 (stanislaw)
  • Composable Documents: copy assets in a redundant way for included documents [\#1780](https://github.com/strictdoc-project/strictdoc/pull/1780) ([stanislaw](https://github.com/stanislaw))
    
  • Technical debt: document_screen_view_object: encapsulate render moved node update #1778 (stanislaw)
  • Bump version 0.0.54 #1776 (stanislaw)

0.0.54 (2024-04-17)

Full Changelog

Closed issues:

  • HTML2PDF: UnicodeEncodeError: 'charmap' codec can't encode character '\u02fd' in position 62111: character maps to <undefined> #1773
  • 0.0.53 GUI does not support adding section or requirement to "empty" fragment file. #1765
  • 0.0.53 GUI does not maintain in fragment file the grammar via IMPORT_FROM_FILE #1764
  • Project Diff/Changelog: Ignore changes in included grammars for now #1759
  • Project Diff/Changelog: do not display included documents #1757
  • UI: Store the TOC state for each node #1755
  • Minor improvement of CSS layout: Nested documents #1752
  • Source path shall be input path when not specified explicitly #1723
  • 2024-Q1: Ongoing requirements work #1563
  • 2024-Q1: Documentation train #1562
  • Document finder: filter out the asset folders based on the included/excluded search paths #1369
  • Feature onmouseclick section or requirement edit #1176
  • Document tree screen: redesign folder/sdoc cells #1021

Merged pull requests:

  • document_from_file: fix the resolution of parent Document or Section nodes #1775 (stanislaw)
  • Bump version to 0.0.54a1 #1772 (stanislaw)
  • UI: Composable documents: Allow editing root node of included document #1771 (stanislaw)
  • SDoc: SDWriter: refactor to a more simple recursive algorithm #1769 (stanislaw)
  • UI: Composable documents: fix writing back SDoc file with included grammars #1768 (stanislaw)
  • HTML2PDF: minor changes and tests for UTF8 support on Windows #1767 (stanislaw)
  • Source files finder: source_root_path shall be input path when not specified explicitly #1763 (stanislaw)
  • export/html: collapsible_toc.js : Store the TOC state for each node #1762 (mettta)
  • Document finder: filter out the asset folders based on the included/excluded search paths #1761 (stanislaw)
  • Project Diff/Changelog: Ignore changes in included grammars for now #1760 (stanislaw)
  • Project Diff/Changelog: do not display included documents #1758 (stanislaw)
  • export/html: update CSS for project tree on the document page #1754 (mettta)
  • Bump version to 0.0.53 #1753 (stanislaw)

0.0.53 (2024-04-01)

Full Changelog

Merged pull requests:

  • docs: update Roadmap #1751 (stanislaw)
  • Code climate: CompositeRequirement -> SDocCompositeNode #1750 (stanislaw)
  • export/json: fix and simplify the iteration algorithm one more time #1749 (stanislaw)
  • export/html: update 'legend' markup on search/git screens #1748 (mettta)
  • docs: document less portable features #1747 (stanislaw)
  • export/json: do not export included documents by default #1746 (stanislaw)
  • docs: update requirements (ZEP, data integrity, fix all missing statuses, a few rationales) #1745 (stanislaw)
  • Remove all BibTeX bibliography-related code and pybtex dependency #1744 (stanislaw)
  • Code climate: improve a grammar form object class name #1743 (stanislaw)
  • document_iterator: refactor the iteration algorithm #1742 (stanislaw)
  • export/html: add zoomable.js: to zoom and move DTR screen #1741 (mettta)
  • export/json: handle more corner cases: nodes without levels, included documents #1740 (stanislaw)
  • export/html: collapsible_tree.js: double-click only affects current and child folders #1739 (mettta)
  • Bump version to 0.0.52 #1738 (stanislaw)

0.0.52 (2024-03-25)

Full Changelog

Closed issues:

  • UI: Source coverage screen: Migrate to new markup #1733
  • Common include [GRAMMAR] for several documents (per project) #1692
  • UI: Display the node type #1691
  • UI: make errors refer to a field (not a group of fields) #1683
  • Document screen: edge cases when moving nodes with JavaScript #1575
  • Common include [GRAMMAR] for several documents (per project) #1120

Merged pull requests:

  • docs: regenerate Read the Docs #1737 (stanislaw)
  • UI: Source coverage screen: Migrate to new markup #1736 (mettta)
  • tests/end2end/project_index: show_hide_included_documents #1735 (mettta)
  • UI: Edit grammar form: block when a grammar is imported from file #1734 (stanislaw)
  • backend/sdoc: including Grammars from grammar files *.sgra #1732 (stanislaw)
  • backend/sdoc: read/write LAYOUT option #1731 (stanislaw)
  • export/html: introduce "Website" layout folder #1730 (stanislaw)
  • export/html: Display the node type (requirement and custom) in the document view #1727 (stanislaw)
  • docs: regenerate Read the Docs #1726 (stanislaw)
  • export/html: draggable_list_controller.js: Send a request to the server only if the object actually changes position #1722 (mettta)
  • Fix a crash when following the user guide. #1720 (MartyLake)
  • export/html: project_index: add dashboard; enable the option to hide/show fragments #1719 (mettta)
  • Regenerate CHANGELOG #1718 (stanislaw)
  • Bump version to 0.0.51 #1717 (stanislaw)

0.0.51 (2024-03-20)

Full Changelog

Fixed bugs:

  • UI: Search screen: fix the case when finding requirements/sections #1716 (stanislaw)

Merged pull requests:

  • export/html: Update project tree markup #1715 (mettta)

0.0.50 (2024-03-19)

Full Changelog

Fixed bugs:

  • UI: Project tree: Visual artefact when the fragments are not displayed #1709
  • No module named 'requests' when running "export --html2pdf" #1701
  • UI: Diff screen: do not build source file traceability when doing history #1708 (stanislaw)

Closed issues:

  • Implement CSS styles for RST warning and info boxes in HTML #1706
  • Update strictdoc.tmLanguage #1589

Merged pull requests:

  • docs: regenerate Read the Docs #1714 (stanislaw)
  • Bump version to 0.0.50 #1713 (stanislaw)
  • Styles: add CSS for RST admonition markup #1712 (mettta)
  • export/html: project_index: Show fragments by default, disable switcher, add info about including file #1711 (mettta)
  • docs: FAQ: resources: FOSDEM 2024 #1710 (stanislaw)
  • export/html: show the "included documents" only when there are included docs #1705 (stanislaw)
  • backend/sdoc: remove last occurrences of Fragment, document the change #1704 (stanislaw)
  • Migration from Fragments to includable Documents #1703 (stanislaw)
  • html2pdf: fix the issue of running within virtual environments #1702 (stanislaw)
  • Bump version to 0.0.49 #1700 (stanislaw)

0.0.49 (2024-03-11)

Full Changelog

Fixed bugs:

  • auto-uid strips RELATIONS if the REQUIREMENT has no UID/MID #1630
  • BUG: the "Copy to clipboard" button is missing after node editing #1588
  • Adjust the grammar rules and validation rules of the forms. #947
  • models: requirement: preserve REFS when setting a field #1631 (stanislaw)

Closed issues:

  • UI: Edit grammar element: implement the component for human title #1674
  • Documentation: List of DOCUMENT grammar elements does not specify where REQ_PREFIX belongs #1670
  • Extend/change the 'edit' menu on each node. #1661
  • Missing validation on "Edit Grammar" form in the frontend #1659
  • Excel export: export multiple documents with relations between them, document the common commands #1639
  • HTML2PDF: Make the webdriver_manager to avoid downloading newer versions if a cached one already exists #1636
  • auto-uid throws AttributeError when I have a COMPOSITE_REQUIREMENT #1623
  • StrictDoc does not recognize source files with arbitrary extensions #1621
  • Will not process sdoc files in --output-dir #1620
  • HTML pages: bundle all fonts inside StrictDoc's bundle to avoid hitting Internet all the time #1601
  • UI: Editing arbitrary Nodes, not only Requirement #1537
  • Path resolution for fragments: must read fragments relative to the sdoc input path #1261
  • Project tree: highlight the current document #1127
  • Activate collapsible TOC JS code for static HTML export #1097

Merged pull requests:

  • backend/sdoc: writing fragments back to files #1699 (stanislaw)
  • backend/sdoc: writing fragments back to files #1697 (stanislaw)
  • backend/sdoc: rework the parsing algorithm for fragments #1696 (stanislaw)
  • backend/sdoc: resolve relative paths to full paths when importing fragments #1695 (stanislaw)
  • docs: update Roadmap #1693 (stanislaw)
  • Bump version to 0.0.49a7 #1690 (stanislaw)
  • export/html: update form error styles for fields and field groups (driven by HUMAN_TITLE) #1689 (stanislaw)
  • export/html: make collapsible_list.js based on MutationObserver #1686 (mettta)
  • export/html: define the copy_to_clipboard in expandable node components #1685 (mettta)
  • export/html: Use self-hosting fonts #1684 (mettta)
  • Bump version to 0.0.49a6 #1682 (stanislaw)
  • export/html: improve the edit grammar form #1681 (mettta)
  • export/html: highlight current document #1680 (stanislaw)
  • export/dot: minor improvements to the layout #1679 (stanislaw)
  • server: several validation messages: requirement -> node #1678 (stanislaw)
  • Code climate: update to new Ruff settings #1676 (stanislaw)
  • server: requirement_form_object: adapt to custom elements in the last places #1675 (stanislaw)
  • docs: add a note about not detecting .sdoc files in the output/ folder #1673 (stanislaw)
  • docs: SDoc grammar DOCUMENT fields: add REQ_PREFIX #1672 (stanislaw)
  • screens/diff: improve the legend with "HEAD vs HEAD+" #1671 (stanislaw)
  • feat: Make the document grammar editable with respect to human titles #1669 (dahbar)
  • export/dot: disable requirement links #1668 (stanislaw)
  • export/json: basic JSON export #1667 (stanislaw)
  • server: creating grammar elements and arbitrary nodes #1666 (stanislaw)
  • export/html: Preparing the menu structure for adding new node types #1665 (mettta)
  • Some style enhancements #1664 (mettta)
  • export/html: node_controls: Updating the layout and icons for the "Add node" menu #1663 (mettta)
  • Refactoring: DocumentGrammarFormObject -> GrammarElementFormObject, move more logic from Jinja to Python #1662 (stanislaw)
  • html2pdf: update bundle.js: Paragraph: split nested inline elements #1660 (mettta)
  • export/html: introduce view_objects to encapsulate Jinja templates data #1657 (stanislaw)
  • html2pdf: update bundle.js: Add options to manually invoke or automatically run the script #1656 (mettta)
  • Refactoring: Document -> SDocDocument #1655 (stanislaw)
  • Refactoring: Section -> SDocSection #1654 (stanislaw)
  • Refactoring: Requirement -> SDocNode #1653 (stanislaw)
  • Refactoring: rename three helper classes from Requirement* -> Node* #1652 (stanislaw)
  • Refactoring: requirement.py -> node.py #1651 (stanislaw)
  • Refactoring: Node -> SDocObject #1650 (stanislaw)
  • html2pdf: update bundle.js: Fix 'block overruns the page bottom' #1649 (mettta)
  • html2pdf: update bundle.js: Add <object> preprocessing #1648 (mettta)
  • Regenerate CHANGELOG #1647 (stanislaw)
  • tests/end2end: test opening a hyperlink to an CSV asset #1646 (stanislaw)
  • server: main_router: treat everything "not .html" as assets #1645 (stanislaw)
  • export/excel: link Excel export requirement to source files #1644 (stanislaw)
  • export/excel: allow generating Excel files for inter-document relations #1643 (stanislaw)
  • export/html2pdf: customize webdriver cache manager to allow offline use #1642 (stanislaw)
  • fix: Review changes #1641 (dahbar)
  • export/html: implement --view option #1638 (stanislaw)
  • export/html2pdf: improved printing of tables (Firefox edge case) #1637 (mettta)
  • tests/integration: move several feature-related groups to features/ #1635 (stanislaw)
  • fix: Validation for views and proper tests #1634 (dahbar)
  • Bump version to 0.0.49a3 #1632 (stanislaw)
  • feat: Add validation for views #1629 (dahbar)
  • Bump version to 0.0.49a2 #1628 (stanislaw)
  • export/html: render requirement's human titles in HTML #1627 (stanislaw)
  • models: composite requirement: fix requirement_prefix #1626 (stanislaw)
  • Bump version to 0.0.49a1 #1625 (stanislaw)
  • Requirements-to-source tracing: find all source files without exceptions #1624 (stanislaw)
  • Bump version to 0.0.48 #1619 (stanislaw)

0.0.48 (2024-01-24)

Full Changelog

Fixed bugs:

  • BUG: UID: loss of graph integrity during Req editing #1587
  • Standalone export: Ensure that no JS controls from the server are available #1529
  • Recursive copying of the assets shall be limited to a known set of folders #1472
  • Arrow is missing for the last requirement of a document in the requirements coverage page #1298
  • Document file name/url with invisible symbols #774

Closed issues:

  • Traceability Matrix Screen: Small CSS layout tweaks #1553
  • UI: Search screen: Left-align the legend text to make it similar to the Diff screen #1534
  • Diff screen: Make CSS for section free text to always start a new line after its badge #1526
  • Diff screen: the Changelog content doesn't take full width when there is no content to be displayed #1519
  • Diff screen: When "collapse all", scroll to top #1517
  • Diff screen: Analyze performance of "Find and read SDoc files" step #1511
  • Diff/Changelog screen: Part 2: Stabilization and further extensions #1503
  • UI: Diff: Add more explanatory text #1500
  • UI: Diff: Remove extra dotted line artifact #1499
  • Minor visual issue: Search screen: long validation error messages overlap with "Clear query" link #1490
  • 2023-Q4: Ongoing requirements work #1410
  • Export with grammar filter #1374
  • UX: (Make filters in toml available in UI): Unintuitive path generation when creating a new document #1330
  • 2023-Q4: Documentation train #1318
  • DTR view: do not show TOC when there are no requirements #1156
  • Fix node markup for REQUIREMENTS COVERAGE #1111
  • Populating and auto-incrementing requirement UID automatically #1081
  • Introduce an option to activate automatic assignment of Machine Identifiers (MID). #1053
  • Relation between the Document Tree, Requirements Coverage and Source Coverage is confusing. #1037
  • DTR: make parts of the requirements tree collapsible #1031
  • UI: Turn FREE_TEXT into Abstract #940
  • UI: Fix the "H11" issue #910
  • Decide on the names of the content fields #891
  • Feature: Exporting and importing requirement subsets of a document #601
  • Requirements coverage: Make the currently viewed parent requirements stick to the top #510
  • Display the switch even if there are no ranges #427
  • HTML2PDF: Export to PDF #369
  • Feature: Search on HTML pages and CLI #368
  • export/html: Scrolling indication using JS #216

Merged pull requests:

  • docs: minor additions for HTML2PDF and a basic docblock for Python API #1618 (stanislaw)
  • feat: Add grammar for custom views #1617 (dahbar)
  • docs: update Release Notes and Roadmap #1616 (stanislaw)
  • export/html: Requirements coverage -> Traceability matrix (last occurrences) #1615 (stanislaw)
  • docs: include source files from tests/** #1614 (stanislaw)
  • export/spdx: export SPDX to JSON-LD #1613 (stanislaw)
  • export/spdx: Document and Package: generate to SDoc with basic meta info #1612 (stanislaw)
  • export/spdx: use CC0 1.0 as data license, set 3.0.0 for spec version #1611 (stanislaw)
  • export/spdx: meta-level SPDX SDoc tree links back to reqs as source files #1610 (stanislaw)
  • reqs-to-source traceability: forward range-based file links #1609 (stanislaw)
  • file_traceability_index: reorder methods to CRUD #1607 (stanislaw)
  • file_traceability_index: annotate all data containers #1606 (stanislaw)
  • export/spdx: view SPDX through SDoc (basic skeleton) #1605 (stanislaw)
  • tests/integration: extract HTML2PDF tests to a separate group #1604 (stanislaw)
  • PDF: fix the split of a long table with unusual properties. #1603 (mettta)
  • export/html2pdf: further improvements for bulk export #1602 (stanislaw)
  • html2pdf: add more debugging lines by using a custom HTTPClient for wdm #1599 (stanislaw)
  • export/html: PDF: improve the empty document check #1598 (stanislaw)
  • export/html: PDF: a temporary solution to detect the empty TOC #1597 (mettta)
  • export/html2pdf: Update page breakers types in Config API and logic #1595 (mettta)
  • export/html2pdf: update bundle and Config API #1594 (mettta)
  • export/html2pdf: update to latest bundle #1593 (stanislaw)
  • export/html2pdf: generate HTML and PDF together for easier inspection #1592 (stanislaw)
  • server: implement "export to PDF" function in UI and CLI #1591 (stanislaw)
  • server: create_requirement: validate uniquess of UID field #1590 (stanislaw)
  • export/spdx: remove all TBDs for now as creating noise #1586 (stanislaw)
  • export/spdx: boilerplate for exporting SDoc tree to SPDX #1585 (stanislaw)
  • Bump version to 0.0.48a2 #1584 (stanislaw)
  • export/html: move toc node: add assert on whereto parameter #1583 (mettta)
  • docs: connect more most obvious requirements with files #1582 (stanislaw)
  • export/html: register JS file type, use TextLexer() for unregistered formats #1581 (stanislaw)
  • docs: move all "Backlog"-status requirements to Backlog #1580 (stanislaw)
  • docs: link several remaining L2 requirements to L1, provide file links #1579 (stanislaw)
  • docs: link several L2 requirements to L1, provide file links #1578 (stanislaw)
  • docs: add several most obvious req-file links (2) #1577 (stanislaw)
  • docs: update project goals #1576 (stanislaw)
  • docs: bring in all draft requirements #1574 (stanislaw)
  • drafts/requirements: parent link for SDOC-SRS-18 (SDoc data model) #1573 (stanislaw)
  • traceability_index: more precise update of links between documents #1572 (stanislaw)
  • export: html2pdf: print publication date #1571 (stanislaw)
  • docs: add the initial architecture diagram #1570 (stanislaw)
  • traceability_index: finalize the delete_requirement() method #1569 (stanislaw)
  • export/html: improve traceability matrix table layout #1567 (mettta)
  • UI: Scroll indication and targeting in TOC #1566 (mettta)
  • docs: update Roadmap #1565 (stanislaw)
  • graph/many2many_set: further improve handling of 1-1 and many-many links #1561 (stanislaw)
  • traceability_index: improve handling of sections metadata #1560 (stanislaw)
  • traceability_index: move requirements links to the new database class #1559 (stanislaw)
  • traceability_index: move more links to the new database class #1558 (stanislaw)
  • traceability_index: database: simplify handling of sections, anchors and links #1557 (stanislaw)
  • tests/end: move_node: improve the stability of the test #1555 (stanislaw)
  • Code climate: traceability_index: group methods by get, update, remove, validate #1554 (stanislaw)
  • Mass-rename: Requirements Coverage -> Traceability Matrix (part 1) #1552 (stanislaw)
  • docs: Machine identifiers (MID) #1551 (stanislaw)
  • export/html: Diff: display MIDs for requirements, sections, and documents #1550 (stanislaw)
  • export/html: edit requirement: make MID field non-editable #1549 (stanislaw)
  • Code climate: MID class: make it a proper subclass of str #1548 (stanislaw)
  • export/html: requirement_form_object: simplify MID field factory method #1547 (stanislaw)
  • export/html: requirement_form_object: simplify MID field factory method #1546 (stanislaw)
  • export/html: create requirement: display and save MID #1545 (stanislaw)
  • export/html: requirement template: display MID #1544 (stanislaw)
  • main_router: move_node: adjust to recent MID change #1542 (stanislaw)
  • Bump version to 0.0.48a1 #1540 (stanislaw)
  • export/html: Diff: update JS, simplifying skeleton #1536 (mettta)
  • export/html: Diff/Search: improve markup/CSS #1535 (mettta)
  • export/html: fix scroll for diff columns #1533 (mettta)
  • export/html: fix scroll for table_key_value #1532 (mettta)
  • export/html: Requirements Coverage -> Traceability Matrix #1531 (mettta)
  • export/html: fixes in DIFF and Static HTML export #1530 (mettta)
  • export/html: Diff/Search: improve CSS layout, add nav tabs template #1528 (mettta)
  • export/html: DIFF: improve matching of sections and document UID, write more tests #1527 (stanislaw)
  • export/html: DIFF: improve matching of comments #1525 (stanislaw)
  • export/html: DIFF: update Changelog content view #1524 (mettta)
  • export/html: DIFF: add a legend to explain the most basic query rules #1523 (stanislaw)
  • file_tree: improve file finding filter #1521 (stanislaw)
  • Diff screen: Introduce the second tab with Changelog screen #1520 (stanislaw)
  • export/html: DIFF: make the JS script not a module, to work in a static export #1516 (mettta)
  • Code climate: remove the second favicon.ico #1515 (stanislaw)
  • drafts/requirements: generate MID identifiers for all nodes #1514 (stanislaw)
  • backend/sdoc: Requirement, Section, Document: add MID field to grammar #1513 (stanislaw)
  • export/html: fix the REQUIREMENT's field name CSS (to not break words apart) #1506 (stanislaw)
  • docs: update the roadmap diagram #1505 (stanislaw)
  • document_meta: also store input doc relative path and the doc file name #1501 (stanislaw)
  • export/html: DIFF: package Section changes in a dedicated SectionChange class #1498 (stanislaw)
  • export/html: DIFF: improve preloader #1497 (mettta)
  • export/html: DIFF: add skeleton preloader #1496 (mettta)
  • export/html: update form messages markup #1494 (mettta)
  • export/html: DIFF: match requirements without UID, with the same title/statement/rationale #1493 (stanislaw)
  • server: /diff endpoint: fix the lhs vs rhs calculation of git trees #1492 (stanislaw)
  • export/html: DIFF: synchronize display of right and left fragment #1491 (mettta)
  • project_statistics: calculate total sections #1489 (stanislaw)
  • project_statistics: calculate sections without any free text, add relevant query #1488 (stanislaw)
  • drafts/requirements: L1: Summary of user needs, more section texts #1487 (stanislaw)
  • UI: Diff Screen to review changes between document trees #1485 (stanislaw)
  • export/html: relax update_requirement by only regenerating the updated document itself #1484 (stanislaw)
  • export/html2pdf: project config option for custom document template #1483 (stanislaw)
  • docs: update "Security considerations" #1482 (stanislaw)
  • UI: Create Document validations: document path is not white-/blacklisted in the config #1481 (stanislaw)
  • docs: release notes fix #1480 (stanislaw)
  • export/html: file traceability: add RST lexer #1479 (stanislaw)
  • Regenerate automatic CHANGELOG #1478 (stanislaw)
  • Bump version to 0.0.47 #1477 (stanislaw)

0.0.47 (2023-11-20)

Full Changelog

Fixed bugs:

  • Fix Jinja crashing on .DS_Store from newer versions of Jinja (somewhere Python >3.7) #1433 (stanislaw)
  • UI: DTR screen: fix link: go to DOC view #1432 (stanislaw)

Security fixes:

Closed issues:

  • Search screen: minimal CSS improvements #1462
  • Document option: ROOT true/false to indicate the root nodes in the traceability graph #1429
  • Create requirement: add comment: implement a missing functionality, add a test case #1412
  • Update requirement relations: strip whitespaces before and after a copy-and-pasted UID #1411
  • Deep trace: add a clickable link to a full requirement card #1407
  • Improve the "copy to clipboard" function to use static HTML #1406
  • CI: Flaky test on Windows #1397
  • Deep traceability: zoom view: add vertical scrolling #1392
  • Requirement-to-source traceability: single-line @sdoc markers #1359
  • Double-check the issue with Jinja crashing on .DS_Store files #1356
  • UID autogeneration: Further improvements #1271

Merged pull requests:

  • export/html: update Header component #1476 (mettta)
  • docs: document Search, ROOT, source_root_path #1474 (stanislaw)
  • UI: return Precondition Failed for all optional features when not activated #1473 (stanislaw)
  • project_config, UI: ensure that Search is only available in the web interface #1471 (stanislaw)
  • CI: --exit-first on macOS and Linux tests #1470 (stanislaw)
  • html2pdf: implement TOC page numbers generator #1469 (mettta)
  • UI: add UID autogeneration button to section form #1467 (mettta)
  • docs: introduce the Changelog document #1466 (stanislaw)
  • Bump version to 0.0.47a6 #1465 (stanislaw)
  • export/html: search: improve page-tips #1464 (mettta)
  • Bump version to 0.0.47a5 #1463 (stanislaw)
  • html/templates: search: update the query syntax legend #1460 (stanislaw)
  • export and passthrough: support --filter-requirements/sections option #1459 (stanislaw)
  • project_config: "source_root_path" parameter to indicate the files root #1458 (stanislaw)
  • export/html: Search: add case with empty search query #1456 (mettta)
  • query_object: whitelist "UID", "STATUS", "RATIONALE" for now #1455 (stanislaw)
  • Bump version to 0.0.47a4 #1454 (stanislaw)
  • export/html: update project_statistics markup #1453 (mettta)
  • export/html: Search: add message "Nothing matching the query was found." #1452 (mettta)
  • export/html: 'UID reset button' on the requirement form #1451 (mettta)
  • export/html: search: node.contains(...) expression #1450 (stanislaw)
  • export/html: search: implement is_root, A not in B, None #1449 (stanislaw)
  • export/html: search: add "help text" placeholder when screen is empty #1448 (mettta)
  • export/html: markup for search screen #1447 (mettta)
  • query_engine/query_object: handle "X in None" case #1446 (stanislaw)
  • query_engine: switch to textX-based parser, stop using eval() #1445 (stanislaw)
  • markup_renderer.py: remove unnecesary assert self.context_document #1444 (mettta)
  • UI: search screen: find requirements and sections using Python query #1443 (stanislaw)
  • drafts/requirements: clean up and update backlog #1442 (stanislaw)
  • drafts/requirements: resolve the second round of TBDs #1441 (stanislaw)
  • drafts/requirements: resolve the first round of TBDs #1440 (stanislaw)
  • pyproject.toml: fix running with Python 3.12 by adding setuptools for now #1439 (stanislaw)
  • GitHub CI: bring back the Python 3.12 jobs #1438 (stanislaw)
  • backend/sdoc/grammar: bibtex: recognize BIBLIOGRAPHY + related changes #1437 (stanislaw)
  • tox: improve bootstrapping Python deps #1436 (stanislaw)
  • Bump version to 0.0.47a3 #1435 (stanislaw)
  • backend/sdoc_source_code: single-line markers #1434 (stanislaw)
  • export/html: DTR: add 'go to DOC view' action for the card view of requirements #1431 (mettta)
  • drafts/requirements: merge the contents of L1 and L2 documents into L2 #1430 (stanislaw)
  • Code climate: remove pylint, flake8, black from dev dependencies #1428 (stanislaw)
  • Code climate: GitHub CI: add Python 3.12 #1427 (stanislaw)
  • tests/end2end: introduce sharding for GitHub CI tests on macOS #1426 (stanislaw)
  • Code climate: Ruff: add "C" group of checks #1422 (stanislaw)
  • Code climate: GitHub CI: reduce a number of jobs run for basic checks on each system #1425 (stanislaw)
  • Code climate: switch to Ruff format, disable Pylint and flake8 #1424 (stanislaw)
  • Code climate: Ruff: add "ARG", "C4" group of checks. Set Python 3.7 as a baseline. #1423 (stanislaw)
  • Code climate: Ruff: add "A" group of checks #1421 (stanislaw)
  • Code climate: Ruff: add "pylint" group of checks #1420 (stanislaw)
  • Bump version to 0.0.47a2 #1419 (stanislaw)
  • tests/end2end: introduce sharding for GitHub CI tests on Windows #1418 (stanislaw)
  • server, UI: requirement relations: strip whitespaces before and after copy-and-paste #1417 (stanislaw)
  • server, export/html: create requirement with comments #1416 (stanislaw)
  • export/html: project_statistics: also print the generation date #1415 (stanislaw)
  • export/html: Improve the "copy to clipboard" function to use static HTML #1414 (mettta)
  • drafts/requirements: elaborate: Relations, Performance, Multirepo, CLI #1413 (stanislaw)
  • gitignore: __*.sdoc #1409 (mettta)
  • drafts/requirements: update to new RELATIONS, elaborate several data model-related requirements #1408 (stanislaw)
  • export/html: form.css: add optional scroll to modal #1405 (mettta)
  • Code climate: limit mypy to the lowest Python of 3.7 #1404 (stanislaw)
  • gitignore: add *.local.toml #1403 (mettta)
  • tests/end2end: try to fix flaky test problem by changing the custom port #1402 (stanislaw)
  • Code climate: tasks: build tox, mypy, pytest, ruff into build/ #1401 (stanislaw)

0.0.46 (2023-10-29)

Full Changelog

0.0.45 (2023-10-29)

Full Changelog

Fixed bugs:

  • Requirements are missing sdoc-anchor #1363
  • Visual bug: The anchors shall not be displayed on requirements #1345
  • CI failure: The macOS GitHub Actions job fails with "Invalid or unsupported XPath" on two tests #1333
  • Bug: Editing text via web ui deletes Refs Type File and Refs Value #1319
  • source coverage exception when source file last line is not empty #1307
  • WebUI Suggestion: Prevent 2 sections from having the same UID #1290
  • Creating/editing the names of custom fields in the grammar #955
  • source coverage: fix case when source file last line is not empty #1308 (stanislaw)

Closed issues:

  • CSS: prevent overflow of fields in the requirement with long strings without breaks #1394
  • UI: update clipboard button styles #1389
  • server: automatically append .sdoc extension if missing when adding a new document #1375
  • Add --version flag to CLI  #1373
  • Long table auto-wrapping/horizontal scrolling #1370
  • UI: end2end tests: TOC and anchors #1368
  • UI: end2end tests: test cloning requirement nodes #1367
  • UI: create end2end tests for LINKS and ANCHORS #1366
  • Minor UI issue: requirement template: the only <p> paragraph without margins #1362
  • tasks: invoke server: add --config parameter #1357
  • UI: Clone/duplicate requirement node #1343
  • Implement relation types (e.g., refines, implements, verifies) #1310
  • CLI: specify a path to the project config with --config parameter #1301
  • Take into account project config last modification date when invalidating caches #1300
  • Path not found: replace assert with proper error handling #1291
  • backend/sdoc: support Child links #1279
  • UI: Editing grammar: ensure that all requirements can be mass-updated when the fields order is changed #1225
  • 2023-Q3: Documentation train #1209
  • Feature: Project statistics / progress report screen #1132
  • Ensure a convention for the custom fields: single-line fields above, multiline fields below #948
  • UI: Make all text fields have a button "copy to buffer" #913
  • ReqIF-SDoc: exporting/importing (roundtrip) #571
  • ReqIF implementation roadmap #520

Merged pull requests:

  • main_router: update_grammar: fix an edge case, improve a flaky test case #1322 (stanislaw)
  • Requirement relations: good 80%+ of the overall implementation #1320 (stanislaw)
  • tests/end2end: rename several tests, update to e2e conventions #1317 (stanislaw)
  • tests/end2end: update to new naming conventions: edit_requirement/_requirement_relations/* #1316 (stanislaw)
  • backend, UI: ParentReqReference: role_uid -> role #1315 (stanislaw)
  • helpers: new form data parser #1314 (stanislaw)
  • templates/components: new set of templates for editing requirements and grammar fields #1313 (stanislaw)
  • export/html: code climate: djLint issues in templates #1312 (mettta)
  • export/html: code climate: djLint issues in templates #1311 (mettta)
  • sdoc/grammar: introduce REFS/RELATIONS/ROLES #1309 (stanislaw)
  • backend/sdoc: recognize REFS/RELATION field in the grammar #1305 (stanislaw)
  • config: take into account config last modification date when invalidating caches #1304 (stanislaw)
  • cli and server: validate --config parameter #1303 (stanislaw)
  • cli and server: support --config parameter #1302 (stanislaw)
  • UI: add missing features related to editing document grammar #1299 (stanislaw)
  • traceability_index: fix finding an existing node with a given UID #1297 (stanislaw)
  • strictdoc.toml: do not generate project statistics by default #1296 (stanislaw)
  • docs: add experimental features, limitations, improve Hello World part #1295 (stanislaw)
  • docs: fix recent RST content markup #1294 (stanislaw)
  • export/rst: add a missing branch to generate Anchors #1293 (stanislaw)
  • export/html: Project statistics screen #1292 (stanislaw)
  • Bump version to 0.0.44a3 #1288 (stanislaw)
  • tests/integration: user-provided ReqIF file with a schema not compliant to ReqIF recommendations #1287 (stanislaw)
  • export/html, server: add Mermaid #1285 (stanislaw)
  • server: 200/304 handling of documents: "Cache-Control": "no-cache" #1284 (stanislaw)
  • server: introduce 200/304 handling of documents #1283 (stanislaw)
  • server: introduce 200/304 handling of assets #1282 (stanislaw)
  • export/html: do not precompile Jinja templates if a project is too small #1281 (stanislaw)
  • backend/sdoc, export/html: support child / reverse parent links #1280 (stanislaw)
  • drafts/requirements: L2 and L3: refine more requirements (SDoc format, Excel, open source, links) #1276 (stanislaw)

0.0.43 (2023-08-13)

Full Changelog

Fixed bugs:

  • Edge case: crash when renaming section UID #1245
  • export/html: moving nodes edge case #1232
  • grammar/type_system : change test of non-empty strings #1210
  • Minor visual issue: the DTR screen shows slightly corrupted TOC styles #1179

Closed issues:

  • Known issue: Jinja2 template compiler chokes on .DS_Store files of macOS #1266
  • Time to do something with ERR_CONNECTION_REFUSED Selenium errors on Linux CI #1217
  • multi-line fields not preserving whitepace in all formats (rst:yes, html:no) #1212
  • Unable to reference .cc files #1199
  • Double-check if we want to allow RST quote blocks starting free text blocks #1148
  • Investigate: test 'export tree to reqif' (sometimes) fails on Windows #1100
  • 2023-Q2: Documentation train #1074
  • UI: Section: Incoming/outgoing links #1045
  • Document TOC tree: minor UI issue: difference in offset of Section and Requirement #1013
  • Missing documentation for inline links #725
  • Feature: Links to Sections #382
  • Traceability: show parent links with missing parents #366

Merged pull requests:

  • Bump version to 0.0.43 #1275 (stanislaw)
  • export/html/html_templates: filter out .DS_Store files when compiling Jinja templates #1274 (stanislaw)
  • UI: generate the UID automatically when creating requirements #1273 (stanislaw)
  • drafts/requirements: L1 and L2 reqs: compliance management and compliance matrices, requirements and source files traceability, auto UIDs #1270 (stanislaw)
  • drafts/requirements: L1 reqs: integration between distinct projects requirements trees and reverse parent links #1269 (stanislaw)
  • drafts/ and docs/: merge the old and new backlog items #1268 (stanislaw)
  • drafts/requirements: L1 reqs: SDK and DB, general usability and UX, large number of users, qualification #1267 (stanislaw)
  • docs: document the [LINK: ...] feature #1265 (stanislaw)
  • backend/reqif: ReqIFz roundtrip #1264 (stanislaw)
  • Code climate: fix E721 #1263 (stanislaw)
  • export/rst: multiline fields: make a newline break after field name #1262 (stanislaw)
  • Code climate: tests/end2end: migrate more tests to new conventions #1260 (stanislaw)
  • backend/sdoc and rst_to_html: take into account the output directory when hashing picked file names #1259 (stanislaw)
  • export/html: improvements in the caching algorithm #1258 (stanislaw)
  • backend/sdoc: optimize grammar for some more performance #1257 (stanislaw)
  • export:/html2pdf: add frontpage template #1256 (mettta)
  • Bump version to 0.0.43a7 #1255 (stanislaw)
  • Code climate: tests/end2end: update more tests to latest conventions #1254 (stanislaw)
  • backend/reqif: more explicit default ReqIF profile: "P01 SDoc" #1253 (stanislaw)
  • tests/end2end: migrate 2 test cases to E2ECase #1252 (stanislaw)
  • backend/sdoc: reader: good performance improvement from pickling parsed SDoc content #1251 (stanislaw)
  • export/html: PDF: adding pdf-version for anchored title components #1250 (mettta)
  • drafts/requirements: more statuses and links for reqs in the SDoc-level spec #1249 (stanislaw)
  • Code climate: tests/end2end: adjust update_section group to new conventions #1248 (stanislaw)
  • export/html, server: fix a branch: rename section UID #1247 (stanislaw)
  • drafts/requirements: assign status and links to more trivial requirements #1246 (stanislaw)
  • export/html: PDF & CSS: fixes unexpected margins #1244 (mettta)
  • drafts/requirements: StrictDoc reqs: assign Active status to several reqs #1243 (stanislaw)
  • export/dot: profile2: take into account folders #1242 (stanislaw)
  • export/html: incoming links to sections and anchors #1241 (stanislaw)
  • drafts/requirements: activate status of 3 SDoc reqs #1240 (stanislaw)
  • export/html: update style for document and section meta #1239 (mettta)
  • drafts/requirements: export/import requirements: allocate statuses, connect some SDoc grammar reqs #1238 (stanislaw)
  • export:/html2pdf: replace requirement outline with border #1237 (mettta)
  • drafts/requirements: assign status fields for ZEP and SDoc dev constraints #1236 (stanislaw)
  • export:/html2pdf: bundle.js: improve grid splitting #1235 (mettta)
  • export/html, server: fix edge case when dropping a req on another req #1234 (stanislaw)
  • drafts/requirements: more links and statuses, also move DO-178C to the HLR level #1233 (stanislaw)
  • drafts: integrate new StrictDoc requirements work #1231 (stanislaw)
  • HTML2PDF: basic implementation #1230 (stanislaw)
  • export/dot: several improvements: reqs title UIDs and URL link back to server #1228 (stanislaw)
  • Update README.md: Fix CI badges #1227 (stanislaw)
  • tests/end2end: switch some more tests to new E2E class #1226 (stanislaw)
  • tests/end2end: switch edit_document_classification test to new E2E class #1224 (stanislaw)
  • export/html: CSS: remove a.reference.external style #1223 (mettta)
  • UI: updating section: many more combinations of anchors and links use cases #1222 (stanislaw)
  • backend/sdoc: requirement: make STATEMENT mandatory in custom grammar #1221 (stanislaw)
  • tests/end2end: retry 3 times when Selenium CONNECTION_REFUSED is hit #1220 (stanislaw)
  • Code climate: backend/sdoc/models: switch to using MID instead of str #1219 (stanislaw)
  • tests/end2end: start catching Selenium exceptions more targeted #1218 (stanislaw)
  • tests/end2end: add a test for adding LINK to an existing section ANCHOR #1216 (stanislaw)
  • grammar, anchors: handle edge case of malformed RST #1215 (stanislaw)
  • export/html: fix RST rendering for custom fields #1214 (stanislaw)
  • docs/strictdoc_01_user_guide.sdoc: remove accidental debug lines #1213 (stanislaw)
  • resolve #1210: leading spaces allowed #1211 (BenGardiner)
  • export/dot: add legend and folder clusters, improve sorting of flowdown #1208 (stanislaw)
  • export/dot: color-code requirement status, add legend #1207 (stanislaw)
  • export/dot: profile1: randomize link colors to simplify tracing #1206 (stanislaw)
  • export/html: fix margins in DOC TREE #1205 (mettta)
  • export/html: fix TOC styles for disabled items on DTR screen #1204 (mettta)
  • export/html: Make anchors visible on hovering over the node #1203 (mettta)
  • export/html: Adding anchor visualisation #1202 (mettta)
  • export/dot: basic export to Graphviz/DOT #1201 (stanislaw)
  • export/html, source traceability: add support for C++/.cc extension #1200 (stanislaw)

0.0.42 (2023-06-18)

Full Changelog

Fixed bugs:

  • UI section move internal error #1185

Closed issues:

  • UI link inner document reference, i.e. RST citations feature #1191
  • server error on "big" inlined csv-table directive #1171
  • Feature request: support include_directories and exclude_directories option for traceability #1157
  • Performance profiling of Python code: set up the infrastructure #1129
  • Warnings during tests: deprecated tools and requests to update to Node.js 16 and to using Environment Files. #1101
  • Project config: features: implement and document ALL_STABLE and ALL_EXPERIMENTAL. #1050
  • Option: enable strict mode: turn warnings into errors #451

Merged pull requests:

  • Bump version to 0.0.42 #1198 (stanislaw)
  • helpers/exception: all warnings are turned into errors by raising StrictDocException #1197 (stanislaw)
  • file_system: improve the sync_dir reporting capability #1196 (stanislaw)
  • tasks: performance task to generate and visualize profiling info #1195 (stanislaw)
  • traceability_index: introduce a basic graph database class #1194 (stanislaw)
  • Code climate: simplify some end-2-end test method names #1193 (stanislaw)
  • Feature: reference arbitratry locations in the free text using ANCHOR/LINK #1192 (stanislaw)
  • export/html, source file view: fix two edge cases (empty source files, source files with empty lines) #1190 (stanislaw)
  • cli/command_parser: Fix 'export' format/field msg #1189 (richardbarlow)
  • "manage auto-uid" command: auto-assign UID for sections as well #1188 (stanislaw)
  • main_router: improve the performance of move_node by using the new on-demand loading architecture #1187 (stanislaw)
  • main_router: fix move_node action regression due to the recent refactoring #1186 (stanislaw)
  • "manage auto-uid" command: auto-assign UID for the whole project tree #1184 (stanislaw)
  • project_config: mass refactoring: merge in export config #1183 (stanislaw)
  • cli/cli_arg_parser: extract creation of cmd parsers to a separate class #1182 (stanislaw)
  • strictdoc.toml: introduce ALL_FEATURES umbrella option, switch to features option to toggle the standalone HTML export #1181 (stanislaw)
  • export/html: align the feature toggles with how the HTML components are displayed or hidden #1180 (stanislaw)
  • docs: switch to generating project tree from the root folder #1178 (stanislaw)
  • helpers/path_filter: basic validation of user input #1177 (stanislaw)
  • screens/deep_traceability: edge case: truncate csv-table:: content correctly #1174 (stanislaw)
  • RST-to-HTML: fix the relative/absolute path resolution by csv-table directive #1173 (stanislaw)
  • strictdoc.toml: options to include/exclude doc paths and source file paths #1170 (stanislaw)

0.0.41 (2023-05-21)

Full Changelog

Fixed bugs:

  • strictdoc server does not render .PNG image #1161
  • Yet another flaky UI test: UC112_T01_UI_toc #1155
  • Assets are missing in Windows #1152
  • Problems when starting a server with the --input-path docs #1145

Closed issues:

  • Double-check behavior of REQUIREMENTS_COVERAGE with a feature toggle and CLI argument #1142
  • Adapt SOURCE FILE COVERAGE view to new components #1138
  • Add resizable component to requirements_coverage TOC #1137
  • Project tree: show the full relative path to each document folder #1128
  • pip install fails on win10 due to short path in windows registry #1118
  • pan_with_space.js: JS errors #1116
  • Minor CSS issue: highlight better the distance between paragraphs in requirement rationale #1115
  • Minor CSS issue: it is not possible to create a next requirement because the menu is not accessible #1114
  • Move document nodes using drag-and-drop TOC #1113
  • .. image:: filename.* not rendered #1106
  • tests/end2end: implement a test for TOC collapse/expand #1105
  • tests/end2end: introduce a helper that ensures absence of JS errors in every test #1058
  • Web server: switch to dynamic generation of content as opposed to always rendering all static content #1032
  • Introduce end-to-end tests for requirements-to-source traceability #1019
  • Server and UI: resolve paths to the images correctly #818
  • Ubuntu VM use case: document usage of libtidy when running integration tests #505

Merged pull requests:

  • Bump version to 0.0.41 #1169 (stanislaw)
  • export/html: remove unused draggable_list.js #1168 (mettta)
  • server, export/html: remove last hardcoded path to Stimulus.js #1167 (stanislaw)
  • docs: update to 18/27 of Q2 documentation train #1166 (stanislaw)
  • export/html: implement draggable_list #1165 (mettta)
  • export/html: fix turbo links that were broken by the recent refactoring #1164 (mettta)
  • server: load all document pages on demand #1163 (stanislaw)
  • server, main_router: fix resolution of paths for image assets #1162 (stanislaw)
  • export/html: Connect to websocket relative to current domain #1160 (richardbarlow)
  • tests/end2end: try to fix flaky test: UC112_T01_UI: sleep 1s to let animations finish #1159 (stanislaw)
  • export/html: project tree TOC: print full relative paths #1158 (stanislaw)
  • server: set websocket host to configured server host as well #1154 (stanislaw)
  • Bump version to 0.0.41-alpha #1153 (stanislaw)
  • CI: Fix GitHub Actions deprecation warning about Node v12 #1150 (stanislaw)
  • pyproject.toml: exclude unneeded dependencies when releasing Pip #1149 (stanislaw)
  • tests/end2end: implement a test for collapsible list #1147 (mettta)
  • export/html: add bottom margin for requirement content items #1146 (mettta)
  • export/html: Move nav panel in source_file_view to left #1144 (mettta)
  • UI: Add resizable component to requirements_coverage TOC #1143 (mettta)
  • UI: improving panning on the deep-traceability screen #1139 (mettta)
  • export/html: fixes dragging content on the deep-traceability page #1136 (mettta)
  • export/html: center content block on document page #1135 (mettta)
  • UI: add a right-hand modification to the resizable bar, and move TOC to right #1134 (mettta)
  • Refactoring templates #1133 (mettta)
  • tests/end2end: update port 51000 in test_02_server_host_specified.py #1131 (mettta)
  • export/html: basic support of image.* Sphinx directive #1130 (stanislaw)
  • UI: Improving the behaviour of menus and the appearance of forms when editing #1126 (mettta)
  • UI: add resizable bars for TOC and ProjectTree on document screens #1125 (mettta)

0.0.40 (2023-04-24)

Full Changelog

Merged pull requests:

  • strictdoc.toml: fix how the "port" parameter is recognized #1124 (stanislaw)

0.0.39 (2023-04-23)

Full Changelog

Closed issues:

  • strictdoc.toml config option: server/host parameter that specifies which host Uvicorn binds to #1119

Merged pull requests:

0.0.38 (2023-04-12)

Full Changelog

Fixed bugs:

  • RST parsing edge case: invalid literal for int() with base 10: '1...'. #1026
  • tests/end2end: fix --long-timeouts argument #1108 (stanislaw)
  • export/html: when rendering DTR screen, truncate RST directives to just nothing #1107 (stanislaw)

Closed issues:

  • tests/end2end: a timeout of 5s is not enough on slower (Windows) machines #1104
  • Task release-pyinstaller seems broken #1091
  • tasks: improve the virtual environments infrastructure #1057

Merged pull requests:

  • Bump version to 0.0.38 #1109 (stanislaw)
  • export/html: Fixing bulk controls in the collapsible list #1103 (mettta)
  • backend: upgrade textX grammars to the latest Arpeggio PEG rules #1102 (stanislaw)
  • tests/end2end/helpers: update toc.py usind [data-testid] #1099 (mettta)
  • export/html: CSS: fix scrollbar corner #1096 (mettta)
  • export/html: do not collapse TOC when there is not much content #1095 (mettta)
  • tasks: silently upgrade strictdoc dependencies when needed #1092 (stanislaw)
  • Regenerate CHANGELOG #1090 (stanislaw)

0.0.37 (2023-03-29)

Full Changelog

Fixed bugs:

  • Several errors with strictdoc server, possibly connected to deployment via PyInstaller #1068

Closed issues:

  • Empty statement error #1083
  • Cannot execute strictdoc command #1070
  • CI: set up the end-2-end tests on Windows #1065
  • tasks.py: invoke/venv solution has to be improved #1064
  • Implement the initial SDoc markup highlighting plugin for Visual Studio Code #1059
  • Known issue: test server process leaks semaphore objects when killed by the test script #993
  • SDoc grammar: single vs multiline fields: make a decision #823

Merged pull requests:

0.0.36 (2023-03-23)

Full Changelog

Fixed bugs:

  • Missing Requirements #1060

Closed issues:

  • CI: set up an integration test job for proving the quality of the latest released Pip package #1067

Merged pull requests:

0.0.35 (2023-03-23)

Full Changelog

Fixed bugs:

  • strictdoc server temp file permission denied on Windows 10 #1061

Closed issues:

  • Web UI Backend #563

Merged pull requests:

0.0.34 (2023-03-21)

Full Changelog

Fixed bugs:

  • Dragging the DEEP TRACE board is very slow #1016
  • File Traceability: Highlight issues when tagging ranges outside of one of the referenced files #990
  • Saving multiple fields at once in grammar does not work. #954
  • UI: bug: After saving the document configuration, the page type menu in the header does not work #939
  • Double-check empty comment validation when editing requirement #895
  • Javascript issue: TypeError: undefined is not an object (evaluating 'this.ranges[rangeAlliace][reqId]') #826

Closed issues:

  • Switch to collapsed TOC by default #1051
  • Introduce end-to-end tests for DTR screen #1033
  • Requirement style Table does not always work correctly (regresses to Simple style) #1027
  • UI: Switch to monospace font for all editable fields #1015
  • Uvicorn shall not watch for changes in files in the integration test folder #1011
  • UI: document view header: include title in turbo-frame #1008
  • Deep-traceability: make a short view for requirement + open the full view in a modal #1005
  • Static HTML export: remove node reactions on hovering #998
  • Create placeholder for empty views (trace and deep-trace) #995
  • Error when cancelling editing of a specific section #991
  • TBL: table's top border is missing #980
  • Escape/unescape in requirement field #977
  • Bug in contenteditable #975
  • Local development issue: resolving import paths when called outside strictdoc/ folder #968
  • CI: Flaky tests caused by pytest not starting the server on time #966
  • Display validation messages as a list if there is more than one message #952
  • Add confirmations for dangerous actions #945
  • Wrong behavior of UI items in the menu #931
  • Document tree: remove DOC/TBL/TR/DTR badges #927
  • End-to-end tests: create screen-based test helpers to encapsulate all lower-level XPath implementation #926
  • Solve the problem with a SDoc server not being terminated fast enough before the next test starts #925
  • Solve the problem with conflicting /tmp folders where server and end2end tests generate output #924
  • docs: document the existing capability of UI v0 #917
  • UI: finish CSS layout of all editable fields #915
  • DTR: Collapsible cards, so that only the requirement titles are browsable. #914
  • Add StrictDoc label on the generated/server HTML pages #909
  • RST tables: align padding of normal text and padding of bullet list. #907
  • Requirement to source file links: handle validation edge case: missing closing pragmas #902
  • RST to HTML rendering by docutils: improve the styles of tables #888
  • Requirement-to-File links edge case: Pygments ignore the first empty line in a file #877
  • Finish handling of the grammar fields: moving up/down and deleting a new grammar field #872
  • Problems with pyinstaller version (OS X) #837
  • UI: Remaining work before first release #764
  • Feature: HTML/DOC: Make a difference between requirement items and free text more visible #711

Merged pull requests:

  • Bump version to 0.0.34 #1054 (stanislaw)
  • export/html, UI: Switch to collapsed TOC by default #1052 (stanislaw)
  • export/html: improved JS for doing pan over the DTR screen #1049 (stanislaw)
  • export/html: Update the backport to a container-type using @media #1048 (mettta)
  • docs: document the existing capability of UI v0 #1047 (stanislaw)
  • Code climate: rename /project_index and /screens; remove wrongly committed sdoc file #1046 (mettta)
  • tests/end2end: update Screens (TR, DTR, TBL) tests #1044 (mettta)
  • Add end-to-end tests for DTR screen #1043 (mettta)
  • tests/end2end: Updating the node finding method using testid #1041 (mettta)
  • tests/integration: source files traceability: ensure a test with "docs/ + src/" structure #1040 (stanislaw)
  • tests/end2end: update helpers, add init tests for all screen types #1039 (mettta)
  • Bump version to 0.0.34-alpha.1 #1038 (stanislaw)
  • strictdoc.toml: features= parameter for centralized activiation/deactivation of features #1036 (stanislaw)
  • export/html, traceability: fix several JS issues in the source file screen #1035 (stanislaw)
  • export/html: add Jinja extension for assertions in Jinja templates #1034 (stanislaw)
  • tests/end2end: print current test number and how many tests are there #1030 (stanislaw)
  • UI/components: DTR: make a short view for requirement + open the full view in a modal #1029 (mettta)
  • server: do not reload when anything in tests/ is touched #1028 (stanislaw)
  • traceability: minor cleanups and prepare an integration test #1025 (stanislaw)
  • docs: regenerate Read the Docs #1024 (stanislaw)
  • tests/end2end: print a test number when a test starts #1023 (stanislaw)
  • server, UI: fix the escaping of RST strings in multiline fields #1018 (stanislaw)
  • docs: update Development Plan #1017 (stanislaw)
  • docs: update Requirements and Design #1014 (stanislaw)
  • UI: document view header: include document title in turbo-frame #1010 (mettta)
  • UI: add placeholder for empty views #1009 (mettta)
  • server: handle one case of when editing section is cancelled #1006 (stanislaw)
  • Static HTML export: remove node reactions on hovering #1004 (mettta)
  • tasks.py: stop generating StrictDoc documentation alongside Sphinx HTML export #1003 (stanislaw)
  • UI: Use Confirm when deleting sections and requirements #1002 (mettta)
  • export/html: do not render unique identifiers when static export #1000 (stanislaw)
  • tasks: copy StrictDoc documentation to GitHub pages repo as well #999 (stanislaw)
  • strictdoc.toml: introduce the html_assets_strictdoc_dir parameter #996 (stanislaw)
  • tests/end2end: when exception happens, print out and err output to the console #994 (stanislaw)
  • parallelizer: catch the semaphores-related macOS edge case, document the edge case #992 (mettta)
  • UI: Display multiple validation messages as a list #989 (mettta)
  • UI: Fix field overflow if text has extra long words #988 (mettta)
  • tests: end2end updates #987 (mettta)
  • tests: update UC55/56, Screen_DocumentTree, add Form_ImportReqIF(Form) #986 (mettta)
  • export/html: remove unused static_path variable from HTML templates #985 (stanislaw)
  • tests/end2end: updates #984 (mettta)
  • tests: end2end: add Form class and subclasses for context forms #983 (mettta)
  • UI: TBL view: fix top border #982 (mettta)
  • export/html: rename all _*.* files to *.* #981 (stanislaw)
  • tests/end2end: more explicit configuration of all timeouts #979 (stanislaw)
  • tests/end2end: update UC11/12/20 #978 (mettta)
  • tests/end2end: update UC07 #976 (mettta)
  • pyproject.toml: remove MarkupSafe workaround version pin #974 (stanislaw)
  • pyproject.toml: remove beautifulsoup4 as obsolete #973 (stanislaw)
  • NOTICE file #972 (stanislaw)
  • LICENSE: provide an explicit copyright line #971 (stanislaw)
  • UI: forms: Update the form layout, the output of the fields and the field action buttons. #970 (mettta)
  • reqif/p11_polarion: accommodate for a yet another spec object type #969 (stanislaw)
  • tests/end2end: introduce screen-based test helpers: UC07_T01 #967 (mettta)
  • UI: Add requirement 'table/zebra' display modes #965 (mettta)
  • server, UI: finish the implementation of saving multiple grammar fields #963 (stanislaw)
  • tests/end2end: migrate tests to safe server code: UC55 and other #961 (stanislaw)
  • tests/end2end: migrate tests to safe server code: UC11 and UC12 #960 (stanislaw)
  • tests/end2end: migrate tests to safe server code: UC10 #959 (stanislaw)
  • tests/end2end: migrate tests to safe server code: UC09 #958 (stanislaw)
  • tests/end2end: migrate tests to safe server code: UC08 #957 (stanislaw)
  • tests/end2end: migrate tests to safe server code: UC07 #956 (stanislaw)
  • tests/end2end: migrate tests to safe server code: UC07_G[1-2] #953 (stanislaw)
  • tests/end2: bring UC08-UC10 to latest naming conventions #951 (stanislaw)
  • tests/end2end: migrate tests to safe server code: UC06 #950 (stanislaw)
  • tests/end2end: migrate tests to latest naming conventions: UC00, UC01 #949 (stanislaw)
  • tests/end2end: migrate tests to safe server code: UC03: T01-T07 tests #946 (stanislaw)
  • UI: add turbo-template for the document title… #944 (mettta)
  • tests/end2end: ensure the server is stopped when any exception occurs #943 (stanislaw)
  • UI: remove unused code #942 (mettta)
  • UI: display document title on the table view #941 (mettta)
  • UI: Add StrictDoc label on the generated/server HTML pages #938 (mettta)
  • tests/end2end: reuse the browser session to speed up the tests #937 (stanislaw)
  • server: create the output in the temporary directory unless specified #936 (stanislaw)
  • docs: regenerate Read the Docs documentation #935 (stanislaw)
  • docs: updates to FAQ, add Credits #934 (stanislaw)
  • UI: Document tree: remove DOC/TBL/TR/DTR badges #933 (mettta)
  • UI: Fix wrong behavior of UI items in the menu #932 (mettta)
  • backend/reqif: handle the edge case with <xhtml:object> tag #930 (stanislaw)
  • RST tables: align padding of normal text and padding of bullet list. #929 (mettta)
  • UI: Fix table border in Safari #928 (mettta)
  • UI: forms: components/form/field #922 (mettta)
  • UI: forms: Requirement parent link #921 (mettta)
  • docs: regenerate Read the Docs documentation #920 (stanislaw)
  • docs: FAQ: document basic web server recommendations #919 (stanislaw)
  • docs: update Backlog #918 (stanislaw)
  • UI: forms: update grammar fields #916 (mettta)
  • UI: forms: add a default field_name value for newly added fields #906 (mettta)
  • UI:forms: edit grammar #905 (mettta)
  • Code climate: ruff: activate ERA #904 (stanislaw)
  • Code climate: ruff: activate most of UP group #903 (stanislaw)
  • Code climate: fix all T201 errors #901 (stanislaw)
  • export/html: support linking requirements with Jinja files #900 (stanislaw)
  • backend/sdoc_source_code: introduce the @sdoc keyword #899 (stanislaw)
  • Code climate: upgrade link_health.py #898 (stanislaw)
  • UI: forms: comment fields #897 (mettta)
  • UI: update 'edit section/requirement' forms templates #896 (mettta)
  • server: update requirement: only regenerate the document's own SDoc file #894 (stanislaw)
  • docs: regenerate Read the Docs documentation #892 (stanislaw)
  • export/rst: fix edge case when rendering RST section titles #890 (stanislaw)
  • UI: update form/modal markup and CSS #889 (mettta)
  • requirements coverage: hide under the traceability flag for now #887 (stanislaw)
  • docs: User Guide: add a link to strictdoc-examples repository #886 (stanislaw)
  • server, UI: Document tree: modal forms, test updates #883 (mettta)
  • docs: requirements: remove composite requirements #881 (stanislaw)
  • Source file traceability: fix edge case: Pygments ignore the first empty line in a file #878 (stanislaw)
  • UI: fix line on the top of the source code page #876 (mettta)
  • examples: move in tests/integration/examples, strip from itest files #875 (mettta)
  • docs: FAQ: some numbers #874 (stanislaw)
  • Finish handling of the grammar fields: moving up/down and deleting a new grammar field #873 (stanislaw)
  • server, UI: move editing of the free text into a document config section #869 (stanislaw)
  • server: switch to port 5111 as less popular port #868 (stanislaw)
  • tests/integration/examples: add basic examples #867 (stanislaw)
  • tests/integration: reqif/profiles/p11_polarion/02_escaping_symbols #866 (stanislaw)
  • reqif: p11_polarion: strip XHTML tags from <xhtml:...> namespace prefixes #865 (stanislaw)
  • reqif: introduce p11_polarion profile, parse the user-provided Polarion example #864 (stanislaw)
  • CI: bring back the PyInstaller task on macOS #863 (stanislaw)
  • reqif: improved handling of multi-value enum attributes. #862 (stanislaw)
  • Ensure that multiprocessing.freeze_support() is called in a frozen application #861 (RobertoBagnara)
  • reqif: reqif-to-sdoc: remove the factory class to simplify further work #860 (stanislaw)
  • reqif: import: skip DATE spec object attributes #859 (stanislaw)
  • pyproject.toml: bump ReqIF version, change to >= #858 (stanislaw)
  • Code climate: ruff: activate I group #857 (stanislaw)
  • Code climate: tasks: add ruff linter #856 (stanislaw)
  • server, UI: egse case when editing requirement (no UID) #855 (stanislaw)
  • server, UI: adding/deleting requirement's parent links #854 (stanislaw)
  • traceability_index: method to assign/unassign a requirement parent link #853 (stanislaw)
  • traceability_index: refactoring work towards Web-editable parent links #852 (stanislaw)
  • server, UI: editing table-based requirements #851 (stanislaw)
  • server: validation: do not allow creating documents without .sdoc extension #850 (stanislaw)
  • Code climate: tests/end2end: adjust document tree tests to latest naming conventions #849 (stanislaw)
  • Code climate: tests/end2end: remove debug screenshot lines #848 (stanislaw)
  • server, tests/end2end: run dev server and test servers on different ports #847 (stanislaw)
  • UI: update 'Empty Doc placeholder' template and related tests #846 (mettta)
  • Tests/end2end: delete comments #845 (mettta)
  • Remove Nuitka from the development dependancies #844 (mettta)
  • UI: add Empty Document placeholder and the corresponding test #843 (mettta)
  • tasks: Environment class to encapsulate all compile-time information #841 (stanislaw)
  • UI: Add dropdown menu on nodes #840 (mettta)
  • tests/integration: run strictdoc without any args to attest the PyInstaller bug #839 (stanislaw)
  • tasks: adapt PyInstaller to support "strictdoc server" command #838 (stanislaw)
  • tasks, packaging: allow generating a Windows release under Linux via … #836 (RobertoBagnara)
  • docs: FAQ: SDoc markup and StrictDoc tutorial #834 (stanislaw)
  • server: fix editing of the grammar fields #833 (stanislaw)
  • UI: refactor CSS #832 (mettta)
  • export/html: remove JQuery #829 (stanislaw)
  • export/html: group JS controllers in a dedicated folder #828 (stanislaw)
  • export/html: switch to Python helper for rendering static URLs #827 (stanislaw)
  • server, UI: editing document grammar #825 (stanislaw)
  • models: requirement: remove #tags setter #824 (stanislaw)
  • sdoc/models: requirement: remove @uid, @status, @level setters #822 (stanislaw)
  • sdoc/models: requirement: title -> reserved_title #821 (stanislaw)
  • sdoc/models: requirement: remove title, statement, and rationale setters #820 (stanislaw)
  • grammar, models: remove RequirementComment #819 (stanislaw)
  • server, UI: editing document config: TITLE and VERSION #817 (stanislaw)
  • UI: Dedicated controller for collapsible Table of Contents #816 (mettta)
  • core: project-level TOML config file #815 (stanislaw)
  • server, UI: editing multiple requirement comments #814 (stanislaw)
  • UI: Implement the new layout and behavior changes for the TOC #813 (mettta)

0.0.33 (2023-02-09)

Full Changelog

Closed issues:

  • Problems with pyinstaller version (Linux) #835
  • Automatically add the file format in the form in the project tree page #775
  • strictdoc.toml: introduce project-level config file #587

0.0.32 (2023-01-09)

Full Changelog

Closed issues:

  • Can't install 0.0.29 or 0.0.30: requirements.txt missing #803
  • DEPRECATION: strictdoc is being installed using the legacy 'setup.py install' method #753

Merged pull requests:

  • Bump version to 0.0.32 #810 (stanislaw)
  • export/html: do not display "Export to ReqIF" in the static export #809 (stanislaw)
  • docs: link health: add Bugseng article to exceptions #808 (stanislaw)
  • UI: pan-with-space.js: Use #pan-with-space instead of class #807 (mettta)
  • server, UI: requirement form is rendered from all grammar fields #806 (stanislaw)
  • Code climate: extend linting by flake8 and pylint to tests/* #805 (stanislaw)

0.0.31 (2023-01-05)

Full Changelog

Merged pull requests:

  • tasks, packaging: switch to pyproject.toml, remove setup.py #804 (stanislaw)
  • server: main_router: merge in complete main_controller #802 (stanislaw)
  • server: clean up the main controller using the new API #801 (stanislaw)
  • server: editing requirement's UID #800 (stanislaw)
  • server: editing requirement's rationale #799 (stanislaw)
  • backend/excel/export: Support Excel Export of custom grammar fields #797 (GGBeer)
  • Code climate: introduce helpers/auto_described to print objects #796 (stanislaw)

0.0.30 (2022-12-24)

Full Changelog

Fixed bugs:

  • server: zombie worker processes are left when Selenium timeouts #785
  • UI: problem when adding <> symbols to editable fields #782
  • backend/sdoc: fix the edge case when rstripping the multi-line fields #793 (stanislaw)

Closed issues:

  • export/rst: doens't render the custom fields #779
  • backend/reqif: import the complete documentation tree from a ReqIF file #777
  • Partial evaluation of Jinja templates #453
  • Basic unit and integration test coverage is missing #139
  • export/html: RST->HTML rendering using docutils is a performance bottleneck #138

Merged pull requests:

  • Bump version to 0.0.30 #795 (stanislaw)
  • backend/reqif: update to the latest API #794 (stanislaw)
  • backend/sdoc/grammar: Add REFS-BibReference #792 (GGBeer)
  • backend/sdoc/grammar: Refactoring REFS ParentReqReference, FileReference #791 (GGBeer)
  • backend, sdoc, rst: remove trailing newlines by multistring fields #790 (stanislaw)
  • export, rst: add custom grammar fields into jinja2 rendering #788 (BenGardiner)
  • server: exporting and importing complete document tree #787 (stanislaw)
  • server: fix zombie worker processes issue when Selenium timeouts #786 (stanislaw)
  • server: escape multi-line text when rendering edit forms (requirement, section) #784 (stanislaw)
  • docs: Contributing: How can I help? #783 (stanislaw)
  • export/rst: switch to Jinja template for rendering requirement to RST (take 2) #781 (stanislaw)
  • export/rst: switch to Jinja template for rendering requirement to RST #780 (stanislaw)
  • backend/reqif: exporting document's free text #778 (stanislaw)
  • server: basic importing and exporting ReqIF #776 (stanislaw)
  • Code climate: Do not rely on SD working dirname in ConfTest #773 (GGBeer)
  • tests/integration: try a Windows-friendlier diff command #772 (stanislaw)
  • backend/rst: handle SEVERE errors through the friendlier interface #771 (stanislaw)
  • CI: try Selenium tests on macOS #770 (stanislaw)
  • UI: Make form fields have monospace font #769 (mettta)
  • docs:strictdoc_01_user_guide UGuide updates/restructuring #768 (GGBeer)
  • server: read both single- and multi-line requirement statements #767 (stanislaw)
  • docs: update contributing and development guides #766 (stanislaw)
  • server: trim all form fields, remove trailing whitespace #765 (stanislaw)
  • docs: updates related to the new server work #763 (stanislaw)
  • UI: Filtering text in single line contenteditable fields #762 (mettta)
  • docs: renumber the documents #761 (stanislaw)
  • UI: give the connection status message a more solid look #760 (mettta)
  • backend/sdoc/grammar: Add optional DocumentConfig CLASSIFICATION field #759 (GGBeer)
  • server: initial Web-based GUI (editing doc tree and documents) #758 (stanislaw)
  • backend/sdoc/grammar: Add GRAMMAR for REFS-TypeValue variant #754 (GGBeer)

0.0.29 (2022-12-05)

Full Changelog

Fixed bugs:

  • pip image for 0.0.27 missing requirements.txt #751

Merged pull requests:

0.0.28 (2022-11-30)

Full Changelog

Closed issues:

  • Create SDocObjectFactory to unify how the objects are created from non-grammar sources. #529

Merged pull requests:

  • setup.py: fix issue with packaging requirements.txt file #752 (stanislaw)
  • docs: minor updates to the contribution guideline #750 (stanislaw)
  • Trivial refactoring of has/get_children_requirements and has/get_pare… #749 (GGBeer)
  • Use constants instead of hardcoded Requirement-Fieldname strings. #748 (GGBeer)
  • Regenerate CHANGELOG #747 (stanislaw)

0.0.27 (2022-11-27)

Full Changelog

Fixed bugs:

  • Bug: Left panel on the _source_file screen should always be open #713

Closed issues:

  • Problem with Pyinstaller #740
  • MathJax fonts not always synced #723
  • Feature: HTML export: TBL improvement: switch to a wide Excel-like table #710
  • Display document's meta information: UID and Version #480
  • Recursive copying of assets from the output folders #456

Merged pull requests:

  • Bump version to 0.0.27 #746 (stanislaw)
  • docs: update Discord link #745 (stanislaw)
  • tasks: enable installation using PyInstaller #744 (stanislaw)
  • CI: remove last job with Python 3.6 #743 (stanislaw)
  • traceability_index: remove no longer used code: max depth count #739 (stanislaw)
  • traceability_index: annotate variables with numbers for readability #738 (stanislaw)
  • models/document: remove deprecated "NAME:" field #737 (stanislaw)
  • tests/integration: exercise the fix of incremental copying of assets #736 (stanislaw)
  • CI: try 3.11 on macOS and Linux jobs #735 (stanislaw)
  • CI: Fix Python 3.10 and 3.11 issues [\#734](https://github.com/strictdoc-project/strictdoc/pull/734) ([stanislaw](https://github.com/stanislaw))
    
  • Code climate: html_generator: remove dead code #733 (stanislaw)
  • traceability_index: refactoring: split building index and generating docs #732 (stanislaw)
  • traceability_index: refactoring: bring in all data from the generators #731 (stanislaw)
  • export_action: refactoring: clean up ExportCommandConfig #730 (stanislaw)
  • export_action: refactoring: no need to pass an extra path argument #729 (stanislaw)
  • cli: minor improvement in strictdoc's root path handling #727 (stanislaw)
  • requirements: remove <3.0 limitation on jinja2 #726 (stanislaw)
  • docs: regenerate Read the Docs #724 (stanislaw)
  • Use raw directive for tex instead of double escaping #722 (lochsh)

0.0.26 (2022-06-20)

Full Changelog

Fixed bugs:

  • Bug: AttributeError: 'NoneType' object has no attribute 'required' #675
  • bugfix: AttributeError: 'NoneType' object has no attribute 'required' #699 (stanislaw)

Closed issues:

  • PyLint issue: Cyclic import (strictdoc.backend.sdoc.processor -> strictdoc.backend.sdoc.reader) (cyclic-import) #681
  • Windows support: known issues #491
  • Option: support two types of documents: requirements with titles and requirements with no titles #462
  • Option: Include/exclude requirements in TOC #365

Merged pull requests:

  • Bump version to 0.0.26 #721 (stanislaw)
  • docs: regenerate Read the Docs #720 (stanislaw)
  • export/HTML: fixing white background cutoff in the table view #719 (mettta)
  • export/HTML: Fixing left panel (TOC) behavior #718 (mettta)
  • export/HTML: Isolate CSS for .content-view-table #717 (mettta)
  • export/HTML: Fix white stripe above the table in table-view #716 (mettta)
  • UI: ultimate table view #715 (mettta)
  • docs: FAQ: add FRET and blog posts about StrictDoc #714 (stanislaw)
  • docs: extract F.A.Q. to a separate document #712 (stanislaw)
  • export/HTML: add document META to table view #709 (mettta)
  • docs: move CONTRIBUTING to .sdoc #708 (stanislaw)
  • export/HTML: add document META to document view #707 (mettta)
  • grammar: document_config: expose has_meta() #706 (stanislaw)
  • export/HTML: UI: fix grid in .table-view > .requirement_meta #705 (mettta)
  • tasks: fix dead links task #704 (stanislaw)
  • backend/sdoc: fix handling of LEVEL: None for composite requirements #703 (stanislaw)
  • tasks: switch to python3 everywhere for now #702 (stanislaw)
  • export/HTML: UI: the title is no longer a required field #701 (mettta)
  • tasks: experimental "watch" task #700 (stanislaw)
  • Code climate: fix cyclic import in strictdoc.backend.sdoc.processor #697 (stanislaw)
  • grammar: REQUIREMENT_HAS_TITLE -> REQUIREMENT_IN_TOC #696 (stanislaw)
  • grammar: New option: REQUIREMENT_HAS_TITLE #695 (stanislaw)

0.0.25 (2022-05-08)

Full Changelog

Fixed bugs:

  • Possible bug: flaky test in incremental_generation/03_when_new_child_generate_parents #665

Closed issues:

  • Ordered list incorrect html rendering #653
  • Jinja2 template not found (HTML export) #652
  • Unnumbered sections #639

Merged pull requests:

  • docs: update documentation, introduce design document #694 (stanislaw)
  • tests/integration: move away from a grep-based test #693 (stanislaw)
  • file traceability: improve handling of Windows-style paths #692 (stanislaw)
  • tasks: on Windows: detect if Bash is available #691 (stanislaw)
  • tests/integration: improve rm.py #690 (stanislaw)
  • export/html: integration test for UTF8 symbols in SDoc #689 (stanislaw)
  • tests/integration: Python version of 'cp' and 'rm' to make them portable #688 (stanislaw)
  • tests/integration: Python version of 'touch' and 'mkdir' to make them portable #687 (stanislaw)
  • tests/integration: Python version of cat to make it portable #686 (stanislaw)
  • tasks and tests/integration: portable clean, %cat, and %diff #685 (stanislaw)
  • export/html: link_renderer: always print forward slashes (Windows) #684 (stanislaw)
  • tasks: check_environment: un-hardcode python3 because it fails on Windows #683 (stanislaw)
  • tasks: fix the "The command line is too long." issue on Windows #682 (stanislaw)
  • export/html: table-based requirement template #680 (stanislaw)
  • traceability: simplify handling of source file paths #679 (stanislaw)
  • traceability: source_files_finder: ignored_dirs argument and unit test #678 (stanislaw)
  • HTML export improvements #677 (BenGardiner)
  • developer/design: add a sketch (Affinity Design) #676 (stanislaw)
  • docs: small update in the dev plan #674 (stanislaw)
  • excel/import: optional title for imported documents #673 (BenGardiner)
  • Code climate: tests/integration: prepare test folders #672 (stanislaw)
  • Code climate: try * to enforce named parameters #671 (stanislaw)
  • Code climate: mypy: fix the "assignment" errors #670 (stanislaw)
  • Code climate: mypy: enable --strict and disable remaining checks #669 (stanislaw)
  • requirements.txt: constraint most of the deps to the same major version #668 (stanislaw)
  • backend/excel: keep import and export together #667 (stanislaw)
  • tasks: stop using @task for cleaning the itest artifacts #666 (stanislaw)
  • tasks: do not reset the PATH when running sphinx task #664 (stanislaw)
  • tasks: reset PATH when running from virtual environments #663 (stanislaw)
  • feature: import excel #662 (BenGardiner)
  • docs: extract goals to the development plan draft #661 (stanislaw)
  • requirements.txt: relax all dependencies to >= #660 (stanislaw)
  • requirements.development.txt: relax all dependencies to >= #659 (stanislaw)
  • tasks: fix dead links task #658 (stanislaw)
  • docs: split the documents: User Manual, Requirements and Backlog #657 (stanislaw)
  • CI: set up correct dependencies for periodic checking of dead links #656 (stanislaw)
  • Code climate: improve css fix html rendering for ordered list #654 (gioboske)
  • export/html: support sections without a level #651 (stanislaw)

0.0.23 (2022-04-05)

Full Changelog

Closed issues:

  • Establish workflow for pre-releases #597

Merged pull requests:

0.0.22 (2022-04-03)

Full Changelog

Fixed bugs:

Closed issues:

  • Hello World example seems broken #641
  • Enhancement: docs: checking of dead links #570

Merged pull requests:

0.0.21 (2022-03-07)

Full Changelog

Fixed bugs:

  • Enhancement: Custom grammars: "Hint: Requirement fields" should point to the grammar fields, not requirement's fields #625

Closed issues:

  • Can we update to newer jinja2? #622

Merged pull requests:

0.0.20 (2022-02-24)

Full Changelog

Closed issues:

  • Support for ReqIFz import #592
  • SDoc to Reqif conversion not implemented yet #582
  • Homebrew packaging #578

Merged pull requests:

0.0.19 (2022-02-13)

Full Changelog

Closed issues:

  • Add version subcommand #583
  • Snap package #573
  • Dockerized strictdoc #562

Merged pull requests:

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

0.0.18 (2022-01-01)

Full Changelog

Closed issues:

  • Reference to grammar in docs is broken #564

Merged pull requests:

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

0.0.17 (2021-10-21)

Full Changelog

Closed issues:

  • HTML not being regenerated correctly with multiple SDoc Files #494

Merged pull requests:

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

0.0.16 (2021-09-05)

Full Changelog

Merged pull requests:

  • docs: switch back to guzzle_sphinx_theme for better support by Read the Docs #484 (stanislaw)
  • docs: switch to sphinx_rtd_theme for better support by Read the Docs #483 (stanislaw)
  • Bump version to 0.0.16 #482 (stanislaw)
  • docs: --project-title option #481 (stanislaw)
  • docs: --project-title option #479 (stanislaw)
  • export/html: config option --project-title and display project title #478 (stanislaw)
  • pyproject: remove guzzle_sphinx_theme, switch theme to bizstyle #477 (stanislaw)
  • traceability: validation: do not allow dangling inline links #476 (stanislaw)
  • Feature: Inline links to Sections and Requirements #475 (stanislaw)

0.0.15 (2021-08-19)

Full Changelog

Closed issues:

  • Document-level option to select or disable markup language (RST vs plain text) #465

Merged pull requests:

  • Bump version to 0.0.15 #474 (stanislaw)
  • export/html: fix section-title line-height #473 (mettta)
  • export/html: stop decapitalizing custom field name in the meta table #472 (stanislaw)
  • export/html: requirement meta: fix margins in traceability #471 (mettta)
  • export/html: requirement meta: fix margins, fix background color in t… #470 (mettta)
  • export/html: fix bottom border in requirement meta-table #469 (mettta)
  • export/html: fix bottom border in requirement meta-table #468 (mettta)
  • export/html: styles for table-view, update styles for requirement meta-table #467 (mettta)
  • grammar: document-level option to specify markup (RST and Text for now) #466 (stanislaw)

0.0.14 (2021-08-18)

Full Changelog

0.0.14a (2021-08-18)

Full Changelog

Merged pull requests:

0.0.13 (2021-08-16)

Full Changelog

Closed issues:

  • traceability: improve resolution of full paths during validation checks #448

Merged pull requests:

  • Bump version to 0.0.13 #460 (stanislaw)
  • export/html: ignore "tests" when looking for _assets for now #459 (stanislaw)
  • export/html: update source-file-view, use micro requirement blocks #458 (mettta)
  • export/html: fix reqs in table view, fix reqs width in deep-traceability view, make TR and DTR screens use the same requirement tree #457 (mettta)
  • export/html: prevent recursive search of assets in the output directories #455 (stanislaw)
  • export/html: improve path resolution for source-to-source links #454 (stanislaw)
  • export/html: improve handling of relative paths between reqs and files #452 (stanislaw)
  • traceability: fix the missing source file and requirement warnings #450 (stanislaw)
  • traceability: simplify and improve source files grammar #449 (stanislaw)
  • docs: regenerate Read the Docs #446 (stanislaw)

0.0.12 (2021-08-05)

Full Changelog

Closed issues:

  • Allow images to be displayed in output #445
  • Include mathjax in HTML template to allow for TeX rendering in exported HTML #443
  • export/html: the TOC does not work for sections or requirements with identical name #431

Merged pull requests:

  • Bump version to 0.0.12 #447 (stanislaw)
  • Add Mathjax to base HTML template to allow for TeX rendering #444 (lochsh)
  • Code climate: fix unnecessary lambda warning #442 (stanislaw)
  • traceability: 2 validations of consistency of the req-source links #441 (stanislaw)
  • Code climate: split: traceability_index and traceability_index_builder #440 (stanislaw)
  • traceability: extract and simplify cycle detection code #439 (stanislaw)
  • traceability: detect cycles between requirements #438 (stanislaw)
  • export/html: add requirement-tree to traceability #437 (mettta)
  • Regenerate CHANGELOG #436 (stanislaw)
  • Code climate: fix unnecessary lambda warning #435 (stanislaw)
  • Code climate: fix several long line warnings from flake8 #434 (stanislaw)
  • export/html: Sec and Req anchors section number to ensure link uniqueness #433 (stanislaw)
  • export/html: requirements and source coverage: correct links to source files #432 (stanislaw)
  • docs: add project-level config todo #430 (stanislaw)
  • export/html: Requirements Tree with files branch #429 (mettta)
  • export/html: add files tree in requirements_coverage #428 (mettta)
  • @mettta export/html: requirements-coverage.js #426 (mettta)
  • export/html: hide new traceability-related work under a feature toggle #425 (stanislaw)
  • docs: update backlog #424 (stanislaw)
  • export/rst: catch and report RST-to-HTML conversion warnings #423 (stanislaw)
  • export/html: stop using deprecated window.event #422 (stanislaw)
  • export/html: Requirements Coverage page boilerplate improvements #421 (mettta)
  • Code climate: fix several flake8 warnings #420 (stanislaw)
  • export/html: Requirements Coverage page boilerplate #419 (stanislaw)
  • export/html: fix space behavior in pan-with-space.js #418 (mettta)
  • Code climate: fix unused imports #417 (stanislaw)
  • Code climate: add flake8 linter #416 (stanislaw)
  • export/html: introduce static_path variable #415 (stanislaw)
  • export/html: move root_path and document_iterator vars to Python level #414 (stanislaw)
  • export/html: use Jinja's StrictUndefined, fix found issues #413 (stanislaw)
  • export/html: put index & coverage pages into the base template #412 (mettta)
  • @mettta export/html: source code coverage #411 (mettta)
  • Code climate: Fix several Pylint warnings #410 (stanislaw)
  • traceability: simplify logic of finding source file reqs #409 (stanislaw)
  • traceability: render source lines with reqs in Jinja template #408 (stanislaw)
  • traceability: Support turning on Pygments for C and C++ files #407 (stanislaw)
  • Poetry: update dependencies #406 (stanislaw)
  • export/html: source coverage: simplify source file syntax #405 (stanislaw)
  • export/html: source coverage: generate SDoc keywords in a special way #404 (stanislaw)
  • export/html: add index link in aside header content for doc/coverage … #403 (mettta)
  • export/html: Source code coverage (classes & hashchange) #402 (mettta)
  • export/html: css fix #401 (mettta)
  • traceability: source coverage displays source coverage (3 cases) #400 (stanislaw)
  • Code climate: traceability_index: better function naming #399 (stanislaw)
  • traceability: source coverage page: show stats #398 (stanislaw)
  • traceability: calculate source file coverage at the time of parsing #397 (stanislaw)
  • traceability: read empty and one-line source files #396 (stanislaw)
  • traceability: no ranges, when no requirements point to a source file #395 (stanislaw)
  • traceability: Source Coverage page (draft) #394 (mettta)
  • file_tree: naming improvements, prepare for reuse #393 (stanislaw)
  • document_finder: switch to top-down search and some cleanups #392 (stanislaw)
  • export/html: fix template_type in the title #391 (mettta)
  • export/html: Source code coverage #390 (mettta)
  • Source file view: reqs list #389 (mettta)
  • Making the BASE tpl. shared by documents and source-code pages; TOC improving. #388 (mettta)
  • Code climate: fix some of the LGTM warnings #387 (stanislaw)
  • Code climate: source_files_finder: more meaningful variable names #386 (stanislaw)
  • traceability: detect when requirement link points to the current file #385 (stanislaw)
  • traceability: ensure no requirement duplicates, when multiple file lines #384 (stanislaw)
  • traceability: single file case: fix finding Python files #383 (stanislaw)
  • docs: constraint for sphinx: ~=3.0 #381 (stanislaw)

0.0.11 (2021-05-17)

Full Changelog

Closed issues:

  • The _assets folder is not copied when a doc tree is a single file #341

Merged pull requests:

0.0.10 (2021-04-18)

Full Changelog

Closed issues:

  • ModuleNotFoundError: No module named 'bs4' #336
  • Parallelization: when Jinja crashes, the parent process is not signalled #320
  • Error message: "requirement already exists": make more detailed #318
  • export/html: Fix Pan.js to reflect the latest grid-based layout #232

Merged pull requests:

  • Bump version to 0.0.10 #374 (stanislaw)
  • cli: add a warning that the traceability is not complete #373 (stanislaw)
  • export/rst: preserve original file name instead of using document title #372 (stanislaw)
  • Poetry: use caret "^" for docutils, jinja, and lxml #371 (stanislaw)
  • [Snyk] Security upgrade urllib3 from 1.26.3 to 1.26.4 #370 (snyk-bot)
  • [Snyk] Security upgrade Pygments from 2.5.2 to 2.7.4 #367 (snyk-bot)
  • Code climate: ExportAction: remove self, simplify code #364 (stanislaw)
  • Code climate: move MarkupRenderer down to generators #363 (stanislaw)
  • grammar: Document number #362 (stanislaw)
  • grammar: Document version #361 (stanislaw)
  • cli: include root path to the ExportConfig object #360 (stanislaw)
  • README: Fix badges to the master branch #359 (stanislaw)
  • Front: large number of requirements in aside #353 (mettta)
  • Front: translate code block with boundaries #352 (mettta)
  • scrolling and highlighting code Block depending on parameters in URL #351 (mettta)
  • Front: params in URL #350 (mettta)
  • Front: source page #349 (mettta)
  • sandbox: add a non-range link for hello_world.py #348 (stanislaw)
  • export/html: pan-with-space.js: fix scrolling #347 (stanislaw)
  • export/html: source file view: print all range requirements #346 (stanislaw)
  • export/html: source files: improve <pre> rendering and no last newline #345 (stanislaw)
  • export/html: source files: split contents from Pygments by lines #344 (stanislaw)
  • config: ExportCommandConfig for grouping config options #343 (stanislaw)
  • Basic forward and reverse traceability between SDoc and source files #342 (stanislaw)
  • Parallelizer: switch from Pool to Process: handle exits and exceptions #340 (stanislaw)
  • traceability_index: "requirement already exists" - more detailed message #339 (stanislaw)

0.0.9 (2021-02-01)

Full Changelog

Closed issues:

  • Installation problems on Ubuntu 20.04 #326
  • Enable testing on older Linux distributions #325

Merged pull requests:

0.0.8 (2021-01-24)

Full Changelog

Fixed bugs:

  • Parallelizing with multiprocessing can leave Zombie processes running #313

Closed issues:

  • export/html: store Google font as a local asset #306
  • HTML distribution as one file #279
  • tasks and CI: Set up Black #238
  • export/html: Document tree: adjust styles to handle single files without folders #236

Merged pull requests:

  • Bump version to 0.0.8 #322 (stanislaw)
  • export/html: print children links, allow full left-right navigation #321 (stanislaw)
  • document_finder: include case when intermediate folder has no .sdoc files #319 (stanislaw)
  • tasks: fix install-local task issue #317 (stanislaw)
  • docs: performance feature highlight #316 (stanislaw)
  • tests/integration: test that no fork() warning appears #315 (stanislaw)
  • parallelizer: fix hanging and zombie processes when child processes misbehave #314 (stanislaw)
  • CI: add invoke lint task #312 (stanislaw)
  • Code climate: black-format the rest of strictdoc/**/* files #311 (stanislaw)
  • Enable Python 3.9: Related fixes in the code, enable GitHub action. #309 (stanislaw)

0.0.7 (2021-01-10)

Full Changelog

Closed issues:

  • Fix lost links in TOC on the DEEP TRACEABILITY page #180

Merged pull requests:

0.0.6 (2021-01-07)

Full Changelog

Merged pull requests:

0.0.5 (2021-01-04)

Full Changelog

Closed issues:

  • export/excel: make fields configurable #272
  • Custom fields usage #269
  • HTML anchors are not working #268
  • Excel export #258
  • Styles: Requirement Rationale #249
  • Styles: basic styles for <table> #248
  • export/rst: Print requirement parents #237

Merged pull requests:

0.0.4 (2020-11-17)

Full Changelog

Closed issues:

  • Sphinx PDF vs HTML: Resolve 'single document' vs 'multiple documents' document tree problem #230
  • CI: GitHub Actions deprecation warning: The set-env command is deprecated and will be disabled soon #220
  • export/html: Finish the Table page: remove sections, make the headers float #215
  • export: decide if passing files instead of folders should also work #144

Merged pull requests:

  • export/html: enable passing single files as input #235 (stanislaw)
  • export/html: fix traceability view (central column width) and 'code' styles #234 (mettta)
  • export/rst: do not generate top-level header if single document tree #233 (stanislaw)
  • docs/sphinx: add requirements.txt #231 (stanislaw)
  • docs: regenerate HTML #229 (stanislaw)
  • export/html: Switch to grid layout #228 (mettta)
  • export/html: fix tables template (remove sections and add sticky headers) #227 (mettta)
  • docs/sphinx: Read the version from Poetry #226 (stanislaw)
  • docs: section about Sphinx #225 (stanislaw)
  • CI: Try to fix a deprecation warning from GitHub actions (usage of set-env) #224 (stanislaw)
  • export/html: Add template Inheritance for views (except doc-tree) & styles for tables #223 (mettta)
  • Bump version to 0.0.2 #222 (stanislaw)

0.0.3 (2020-11-10)

Full Changelog

0.0.2 (2020-11-10)

Full Changelog

0.0.1 (2020-11-10)

Full Changelog

Fixed bugs:

  • TOC doesn't have "TOC" printed on the GNC page #210
  • document width on the Columbus page is too wide #202
  • requirement.has_meta should work #185
  • export/html: Document Tree: vertical lines connecting folders and files are sometimes longer than needed #131
  • export/html: link class ".reference.external" misaligns links #126
  • export: weird behavior of search when there is a "/" symbol after an input folder #117

Closed issues:

  • Find a solution for TOC with reqs. without headers #187
  • Requirement href: create generic helper #184
  • export/html: Fix structure of single_document template #182
  • export/html: Document page: print requirement parents #176
  • export/html: make TOC closeable #171
  • export/html: Document page: styles for <blockquote> #167
  • export/html: Document page: add left margin/padding to bullet points inside freetext #166
  • TOC: consider including requirement titles as well #162
  • Separate requirements visually on the "plain" requirements documents #160
  • Introduce CI: GitHub Actions / macOS #158
  • export/html: Unify Requirements partials #156
  • export/html: Fix table view #149
  • textX: parallelize reading sdoc files #147
  • export/html: Main req. cards in Traceability & Deep traceability views must be sharper #143
  • export/html: TOC must be visible on all pages #142
  • CLI: option to provide export output folder #140
  • export/html: The title of the document must be fixed #136
  • export/html: Document Tree: rework generation and improve CSS styles #132
  • export/html: Deep Traceability middle column sometimes gets its cells incorrectly aligned #130
  • export/html: Style for UID field #129
  • export/html: Set correct margin for the Document Tree page #128
  • export: Copy image assets to the export destination directory #109
  • export/html: Add HTML markup validation to the integration tests #108
  • Table view: scroll bar appears for no good reason when switching a table view cell to edit mode #21
  • Recognize header level when parsing RST #12
  • Logger: introduce generic class that can be subclassed to enable logging functionality #11
  • RSTReader: throw exceptions when docutils throws errors/warnings #8
  • RST to HTML writer: check how standalone headers are rendered #4
  • Introduce functional testing #3

Merged pull requests:

  • CI: GitHub action config for releases #221 (stanislaw)
  • CI: GitHub Actions file for Windows #219 (stanislaw)
  • tasks: echo executed commands #218 (stanislaw)
  • docs: regenerate readthedocs content #217 (stanislaw)
  • CI: GitHub Actions file for Linux #214 (stanislaw)
  • export/html: fix empty tags case #213 (mettta)
  • export/html: fix TOC #212 (mettta)
  • export/html: print requirement parents #211 (mettta)
  • export/html: TAGs block #209 (mettta)
  • export/html: TOC and titles #208 (mettta)
  • CI: Python 3.8-related fixes for macOS #207 (stanislaw)
  • CI: GitHub Actions file for macOS #206 (stanislaw)
  • export/html: resolve remaining HTML/XML markup errors + integration test #205 (stanislaw)
  • export/html: document tree: resolve major HTML markup issues #204 (stanislaw)
  • tests/integration: html markup validator draft #203 (stanislaw)
  • export/html: correct links for the documents on the table of contents #201 (stanislaw)
  • dsl/models: minor cleanup and semantic improvements #200 (stanislaw)
  • dsl/models: RequirementContext and SectionContext to store runtime info #199 (stanislaw)
  • export/html: Add TOC bar with pseudo-links #198 (mettta)
  • export/html: TOC and document header improvements, :target highlighting #197 (mettta)
  • export/html: LinkRenderer to manage how the links are created #196 (stanislaw)
  • export/html: delete obsolete html/css files #195 (mettta)
  • export/html: Numerous changes to the layout and styles #194 (mettta)
  • grammar: make sure that the UID field is either a value or None #192 (stanislaw)
  • cli: --no-parallelization option #191 (stanislaw)
  • export/html: fix include rule (requirement.jinja.html) in recursive_c… #190 (mettta)
  • view-table on flex #189 (mettta)
  • export/html: fix include rule (requirement.jinja.html) in recursive_cell #188 (mettta)
  • export/html: Unify Requirements partials (except tables) #186 (mettta)
  • grammar and export: free text is fixed to the sections and document #183 (stanislaw)
  • export/html: Styles for requirements & fix anchors on all pages #181 (mettta)
  • docs: add links to html, sphinx html, pdf #179 (stanislaw)
  • docs: add StrictDoc HTML export #178 (stanislaw)
  • docs: readthedocs integration #177 (stanislaw)
  • docs: update goals #175 (stanislaw)
  • export/html: Document page: styles for <blockquote> #174 (mettta)
  • export/html: fix margins for P and UL #173 (mettta)
  • Make TOC closable #172 (mettta)
  • tests/integration: simple test of parallelized reading and export #170 (stanislaw)
  • helpers/parallelizer: working code for parallelization of textX I/O #169 (stanislaw)
  • docs: fill in some missing parts: Intro, Examples, Doorstop #168 (stanislaw)
  • export/html: Fix table view (media queries) #165 (mettta)
  • export/html: Fix table view #164 (mettta)
  • export/html: Fix table view #163 (mettta)
  • export/html: Makes empty TOC container visible on all pages #161 (mettta)
  • export: fix egde case: input folder with a trailing slash #159 (stanislaw)
  • Remove strictdoc's first generation code #157 (stanislaw)
  • export/html: fix border for meta in requirements #155 (mettta)
  • export/html: meta table for Req., data-attr for titles and requirements #154 (mettta)
  • README: replace TBD #153 (stanislaw)
  • dsl: Requirement@has_meta #152 (stanislaw)
  • docs: add sandbox.sdoc for experiments #151 (stanislaw)
  • export: support both full and relative output paths #150 (stanislaw)
  • cli: export: --output-dir command #148 (stanislaw)
  • cli: cli_arg_parser: parsing is extracted and improved #146 (stanislaw)
  • tests/integration: more basic "export" and "passthrough" itests #145 (stanislaw)
  • export/html: Fixes view-traceability-deep layout #141 (mettta)
  • traceability_index: fix the calculation of the document req depth #137 (stanislaw)
  • export/html: Document Tree markup fixes #135 (mettta)
  • export/html: document tree: switch to ul/li-based styles #134 (mettta)
  • export/html: add main.content to index; move 'toc' vars to :root #133 (mettta)
  • export/html: fix a.reference.external #127 (mettta)
  • docs: good tweaks of the PDF front page #125 (stanislaw)
  • docs/sphinx: section numbers and titles: fix bottom alignment #124 (stanislaw)
  • docs/sphinx: minor tweaks #123 (stanislaw)
  • docs: merge all sdocs into one strictdoc.sdoc #122 (stanislaw)
  • Revert: saturn -> strictdoc :) #121 (stanislaw)
  • Rename: strictdoc -> saturn #120 (stanislaw)
  • Styles #119 (mettta)
  • docs: update roadmap and reqs #118 (stanislaw)
  • Add Poetry skeleton #116 (stanislaw)
  • export/html: TOC: print req.uid if it is present otherwise NO TITLE #115 (stanislaw)
  • export/html: reuse requirement partial on TRACE and DEEP-TRACE pages #114 (stanislaw)
  • export/html: view-traceability css (arrows fix) #113 (mettta)
  • Styles #112 (mettta)
  • grammar: fix single/multiline comments + regenerate tree if strictdoc changes #111 (stanislaw)
  • export/html: export assets to _assets folders #110 (stanislaw)
  • docs: update strictdoc reqs #107 (stanislaw)
  • export/html: incremental generation of the documents #106 (stanislaw)
  • export_action: parallelize HTML generation and print duration time #105 (stanislaw)
  • export_action: almost ready for parallelization but not #104 (stanislaw)
  • export/html: rework output file structure (now mirror source) #103 (stanislaw)
  • docs: add implementation and scalability requirements #102 (stanislaw)
  • Fix imports broken by CLion #101 (stanislaw)
  • export/html: extract to generator classes to separate files #100 (stanislaw)
  • export/html: Renderer: switch to cashing per object, not per text #99 (stanislaw)
  • export/html: Traceability page: render RST #98 (stanislaw)
  • Styles #97 (mettta)
  • export/html: top align table content #96 (mettta)
  • export/html: table view ( html / css ) #95 (mettta)
  • export/html: wrap sections into "<div>.section" #94 (stanislaw)
  • export/html: Document page: add 'requirement' to outer requirement's div #93 (stanislaw)
  • export/html: Table page: render RST->HTML #92 (stanislaw)
  • export/html: new CSS styles for the Document page (also first CSS work on Table) #91 (stanislaw)
  • single_document.css: main.content typograph. styles #90 (mettta)
  • docs: update roadmap, add Getting Started boilerplate #89 (stanislaw)
  • export/html: remove <br>s #88 (stanislaw)
  • layout-main-with-toc.css: fix .link-back-to-index #87 (mettta)
  • export/html: render bold comment word with CSS #86 (stanislaw)
  • export/html: render comments via RST as well #85 (stanislaw)
  • export/html: add Table of Contents panel as <aside> tag with CSS styles #84 (stanislaw)
  • export/html: <span> to each section/requirement to allow jumping to them #83 (stanislaw)
  • export/html: Document page: render RST statements and free text with docutils #82 (stanislaw)
  • export/html: Document page: introduce .section-number CSS class #81 (stanislaw)
  • export/html: Document page: remove artificial space #80 (stanislaw)
  • export/html: table of contents template: switch to <ul> and <li> #79 (stanislaw)
  • export/html: new CSS styles for the document tree page #78 (stanislaw)
  • export/pdf: fix TOC layout when starting from level 3 #77 (stanislaw)
  • export/pdf improvements: switch to DejaVu Sans font, introduce metadata table instead of table logo #76 (stanislaw)
  • docs: 2 items to roadmap #75 (stanislaw)
  • export/html: add last class class to simplify CSS #74 (stanislaw)
  • dsl/reader: specific case of setting ng_level for composite requirement #73 (stanislaw)
  • docs: add empty introduction #72 (stanislaw)
  • export/html: add more classes to enable further CSS styles work #71 (stanislaw)
  • export/html: table view: switch from 'display: table' to <table> #70 (stanislaw)
  • export/html: document_tree: split into name and document link cells #69 (stanislaw)
  • document_finder: switch to depth-first search #68 (stanislaw)
  • export/pdf: better layout of the table logo and other styles #67 (stanislaw)
  • export/pdf: automatic generation of the PDF using Sphinx #66 (stanislaw)
  • export/rst: Initial export code #65 (stanislaw)
  • tests/integration: self-testing passthrough #64 (stanislaw)
  • tests/integration: Hello World passthrough test #63 (stanislaw)
  • Support mounting multiple doc trees into a single export #62 (stanislaw)
  • export/html: Improve automatic numeration of the titles #61 (stanislaw)
  • export/html: single_document_table: minor fix #60 (stanislaw)
  • docs: add more titles and some links #59 (stanislaw)
  • export/html: enable HTML title counters #58 (stanislaw)
  • Grammar: Support [COMPOSITE-REQUIREMENT] #57 (stanislaw)
  • export/html: simplify traceability page styles for now #56 (stanislaw)
  • grammar: support [FREETEXT] #55 (stanislaw)
  • export/html: initial table view page #54 (stanislaw)
  • export/html/export.py: remove obsolete code #53 (stanislaw)
  • export/html: print statement in paragraphs #52 (stanislaw)
  • pan-with-space.js: fix copy and paste functionality that was blocked #51 (stanislaw)
  • DSL: Grammar: Support multiline statements #50 (stanislaw)
  • export/html: Pan with space key and scroll to middle on Deep Traceability pages #49 (stanislaw)
  • export/html: remove <pre> from content body part #48 (stanislaw)
  • export/html: Table-based document tree #47 (stanislaw)
  • html/export: Deep Traceability document, first take #46 (stanislaw)
  • export/html: global CSS style #45 (stanislaw)
  • export/html: display tags #44 (stanislaw)
  • export/html and dsl: introduce multiline comments #43 (stanislaw)
  • export/html: traceability page displays comments #42 (stanislaw)
  • export/html: hacks to make borders collapse on traceability page #41 (stanislaw)
  • export/html: better styles for traceability page #40 (stanislaw)
  • export/html: traceability: anchor links to sections #39 (stanislaw)
  • export/html: first traceability matrix #38 (stanislaw)
  • DSL: Newline after [/SECTION] #37 (stanislaw)
  • DSL: Tags support. Also introduce skipws everywhere in the grammar. #36 (stanislaw)
  • export/html: export sections recursively, export TOCs #35 (stanislaw)
  • Export HTML: Sort dirs/files, add links #34 (stanislaw)
  • export/html: switch to Jinja2 template engine #33 (stanislaw)
  • export: basic export to HTML: document tree structure #32 (stanislaw)
  • strictdoc/backend/dsl: introduce optional REQUIREMENT#STATUS parameter #31 (stanislaw)
  • strictdoc.strictdoc: document requirement item: existing fields #30 (stanislaw)
  • strictdoc/backend/dsl: introduce optional REQUIREMENT#UID parameter #29 (stanislaw)
  • strictdoc/backend/dsl: Requirement has_many references #28 (stanislaw)
  • New StrictDoc DSL: reading input and writing output #27 (stanislaw)
  • Table view: detecting right click on cells and showing context menu #26 (stanislaw)
  • table view: stretching text to the full cell width seems to work #25 (stanislaw)
  • table view: fix animation of background cell when editing #24 (stanislaw)
  • Styles, document model and item delegate: remove blue selection, fix margins #23 (stanislaw)
  • TableView: disable horizontal and vertical headers for now #22 (stanislaw)
  • document metadata: specify fields that must be recognized in metadata nodes #20 (stanislaw)
  • rst_node_finder: fix looking for paragraphs which are easier to find parents for #19 (stanislaw)
  • strictdoc/core/logger: logger class to allow logging of selected classes #18 (stanislaw)
  • backend/rst/rst_document_editor: replace paragraph with paragraph #17 (stanislaw)
  • backend/rst: moving basic nodes around RST tree #16 (stanislaw)
  • backend/rst: recognize level 4 headers #15 (stanislaw)
  • backend/rst: switch to parsing header levels based on their source code lines #14 (stanislaw)
  • tests/unit: move tests out of the src/ #13 (stanislaw)
  • Document: Rendering HTML in view mode and RST in edit mode (first steps) #10 (stanislaw)
  • rst: assign header level to the section nodes when reading RST #9 (stanislaw)
  • backend/rst: basic test_rst_reader unit test #7 (stanislaw)
  • strictdoc/backend/rst: proper namespacing #6 (stanislaw)
  • backend/rst: create dedicated Parser and Reader classes #5 (stanislaw)
  • backend: rst to html writer prototype #2 (stanislaw)
  • gui: make a table cell resize when its edit-mode cell is being edited/resized #1 (stanislaw)

* This Changelog was automatically generated by github_changelog_generator