1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
:sd_hide_title:
:hide-toc:
Introduction
============
.. grid::
:gutter: 2 3 3 3
:margin: 4 4 1 2
:class-container: architecture-bg
:class-row: sd-w-100
.. grid-item::
:columns: 12 8 8 8
:child-align: justify
:class: sd-fs-3
.. div:: sd-font-weight-bold
Bringing Engineering-as-Code to the Sphinx framework.
.. div:: sd-fs-5 sd-font-italic
Combine Docs-as-Code with Application Lifecycle Management,
to track requirements, specifications, test cases, and other engineering objects in your documentation.
.. grid:: 1 1 2 2
:gutter: 2 2 3 3
:margin: 0
:padding: 0
.. grid-item::
:columns: auto
.. button-ref:: installation
:ref-type: doc
:outline:
:color: primary
:class: sd-rounded-pill sd-px-4 sd-fs-5
Get Started
.. grid-item::
:columns: auto
.. button-link:: https://useblocks.com/
:outline:
:color: primary
:class: sd-rounded-pill sd-px-4 sd-fs-5
About useblocks
.. grid-item::
:columns: 12 4 4 4
.. raw:: html
:file: _static/flow_chart.svg
----------------
.. grid:: 1 1 2 2
:gutter: 2
.. grid-item-card:: :octicon:`checkbox;1.5em;sd-mr-1 fill-primary` Adaptable to your needs
An extension for the `Python <https://python.org>`_ based `Sphinx <https://www.sphinx-doc.org>`_ documentation framework,
enabling you to define, link, and analyse engineering objects within your documentation, specific to your project,
such as features, requirements, specifications, test cases, ...
.. grid-item-card:: :octicon:`shield-check;1.5em;sd-mr-1 fill-primary` Developed for safety
Allows you to define the exact way of using and configuring need objects,
to create documentation valid with `ISO 26262 <https://en.wikipedia.org/wiki/ISO_26262>`__,
`DO-178B/C <https://en.wikipedia.org/wiki/DO-178C>`__ or any other safety standard.
.. grid-item-card:: :octicon:`gear;1.5em;sd-mr-1 fill-primary` Highly customizable
Extensive :ref:`configuration options <config>` allow you to adapt the extension to your specific needs,
and the :ref:`built-in API <api>` allows other extensions to extend sphinx-needs for specific solutions.
.. grid-item-card:: :octicon:`sync;1.5em;sd-mr-1 fill-primary` Integration with external sources
Import and export mechanisms facilitate external synchronization with other tools,
such as `JIRA <https://en.wikipedia.org/wiki/Jira_(software)>`__, :ref:`GitHub <github_service>`, or spreadsheets,
allowing for embedding tickets, requirements and other information into your documentation.
.. grid-item-card:: :octicon:`dependabot;1.5em;sd-mr-1 fill-primary` Automated data handling
:ref:`dynamic_functions` allow you to handle complex data chains between needs,
to load and set changeable data automatically during the documentation generation phase.
.. grid-item-card:: :octicon:`workflow;1.5em;sd-mr-1 fill-primary` PlantUML integration
Allows for the creation of specific objects for architecture elements, which can be reused and recombined
in different flow diagrams and higher architecture elements, using `PlantUML <https://plantuml.com>`__.
----------------
.. _other-extensions:
See more from `useblocks <https://useblocks.com>`__ to enhance your sphinx-needs experience:
.. grid:: 1 1 2 2
:gutter: 2
.. grid-item-card::
:link: https://useblocks.com
:img-top: /_static/useblocks-logo-long-dark.svg
:img-alt: https://useblocks.com
:class-img-top: sd-p-3 sd-bg-dark
:class-card: border
Provides an oversight of the useblocks ecosystem, and its goal to bring Engineering-as-Code to the software development process.
+++
.. button-link:: https://useblocks.com
:color: primary
:outline:
:align: center
:expand:
:octicon:`globe;1em;sd-text-primary` useblocks.com
.. grid-item-card::
:link: https://sphinx-bazel.readthedocs.io/en/latest/
:img-top: /_images/logos/sphinx_bazel_logo.png
:img-alt: Sphinx-Bazel
:class-card: border
Provides a Bazel domain in Sphinx documentation and allows the automated import of Bazel files and their documentation.
+++
.. button-link:: https://sphinx-bazel.readthedocs.io/en/latest/
:color: primary
:outline:
:align: center
:expand:
:octicon:`book;1em;sd-text-primary` Technical Docs
.. grid-item-card::
:link: https://sphinx-collections.readthedocs.io/en/latest/
:img-top: /_images/logos/sphinx_collections_logo.png
:img-alt: Sphinx-Collections
:class-img-top: sd-p-2 sd-bg-white
:class-card: border
Extension to collect or generate files from different sources and include them in the Sphinx source folder.
It supports sources like Git repositories, Jinja based files or symlinks.
+++
.. button-link:: https://sphinx-collections.readthedocs.io/en/latest/
:color: primary
:outline:
:align: center
:expand:
:octicon:`book;1em;sd-text-primary` Technical Docs
.. grid-item-card::
:link: https://sphinx-test-reports.readthedocs.io/en/latest/
:img-top: /_images/logos/sphinx-test-reports-logo.png
:img-alt: Sphinx-Test-Reports
:class-card: border
Extension to import test results from XML files as **need** objects.
Created **need** objects can be filtered and linked to specification objects.
+++
.. button-link:: https://sphinx-test-reports.readthedocs.io/en/latest/
:color: primary
:outline:
:align: center
:expand:
:octicon:`book;1em;sd-text-primary` Technical Docs
----------------
Contents
--------
.. toctree::
:caption: The Basics
:maxdepth: 1
Introduction <self>
installation
tutorial
.. toctree::
:caption: Components
:maxdepth: 1
directives/index
roles
configuration
builders
.. toctree::
:caption: How-tos
:maxdepth: 1
filter
dynamic_functions
services/index
layout_styles
api
utils
.. toctree::
:caption: Development
:maxdepth: 1
changelog
support
contributing
license
|
