Sphinx-scale Documentation¶
Sphinx-scale
documents solutions for large setups of Docs-As-Code
environments using Sphinx
as their
main documentation tool.
This documentations provides currently 3 solutions for 3 problems in 4 tools. Additionally 3 demos are available..
Have a problem?
Check if our documented problems are familiar to you and follow their links to one or more solutions.
Get a solution!
Take a look into our solutions for common problems.
Find new tools!
Find new ideas in our tool, extensions and script chapter.
See and analyze demos!
See the implementation of several solutions in different demos.
All data¶
Type |
Title |
ID |
---|---|---|
tool |
Breathe |
|
problem |
Document C++ API in Sphinx |
|
tool |
Doxygen |
|
solution |
Doxygen + breathe for C++ APIs in Sphinx |
|
demo |
C++ API in Sphinx (using Doxygen) |
|
demo |
Sphinx Needs external data |
|
problem |
Add content before/after need |
|
demo |
Nested Need objects |
|
problem |
Document Python API |
|
tool |
Sphinx |
|
solution |
autodoc directive for Python APIs |
|
tool |
Sphinx-Needs |
|
solution |
template option for needs |
Explanation¶
The above tables shows all objects (problems, solutions, …) we have in our documentation.
Use the search box on the upper right side of the table to search for specific content (e.g. api
if you want to find
solutions for how to document your API).
The table supports pagination and the search filter gets executed on all columns,
so you can also search for solution
to get objects of type solution only.
Motivation¶
The content of Sphinx-scale
is based on experiences made in large projects, which mostly have:
> 50 developers / editors
> 500 readers
> 10 shared Sphinx based documentations
> 3 external data sources for additional content (Jira, github, Doors, Enterprise Architect, …)
multiple stakeholders (sw architects, sw developers, sw testers, sw safety officers, project managers, …)