6ec18171a8
Merge pull request 'now that doc server is up, remove markdown files' ( #688 ) from mueller/remove-markdown-docs into development
...
Reviewed-on: fsfw/fsfw#688
2022-10-10 15:04:11 +02:00
d964fa2107
Merge branch 'development' into mohr/documentation_ci
2022-09-30 14:50:20 +02:00
9a2146fa2d
added impressum and datenschutz in sphinx documentation
2022-09-23 11:36:29 +02:00
bcbbc9763a
markdown update not required, will be removed
2022-09-15 14:00:01 +02:00
0042372cb6
now that doc server is up, remove markdown files
2022-09-15 13:58:13 +02:00
8dea13742f
update rst file
2022-09-15 13:57:39 +02:00
0f027d29d2
doc corrections
2022-09-15 13:53:42 +02:00
131e3ff1e3
Revert "doc corrections"
...
This reverts commit 423a9540ed
2022-09-15 13:52:28 +02:00
423a9540ed
doc corrections
2022-09-15 13:51:59 +02:00
217276d50c
renamed returnvalue header
2022-08-16 12:48:22 +02:00
d2ac3603a5
some more occurences
2022-08-16 12:29:53 +02:00
f63f3fa564
more occurences in comments
2022-08-16 12:12:21 +02:00
19817bd3a5
Update 'docs/getting_started.rst'
...
Actually, this version still uses old folder names
2022-08-01 20:47:53 +02:00
1db04cf20c
Update 'docs/getting_started.rst'
...
Update for new recommended build folder and cmake define name
2022-08-01 20:45:39 +02:00
Robin Mueller
4f0669c574
doc update
2022-04-11 16:44:20 +02:00
05495077ec
doc update
2022-03-28 20:53:39 +02:00
6744a55b9b
docs update
2022-02-14 16:31:13 +01:00
a612fb446c
added two links
2022-02-14 16:23:21 +01:00
2dcf896cca
this sounds better
2022-02-10 14:04:23 +01:00
cdf2a90f90
fixed up cross-ref
2022-02-10 14:02:30 +01:00
b25555a533
started DHB docs
2022-02-10 13:53:59 +01:00
d0c7878da4
simplified test controller and added docs gitignore
2021-12-14 17:50:23 +01:00
df45f02c39
script fixes, odd behaviour
2021-12-03 14:55:00 +01:00
c2bf09d506
Introducing documentation with Sphinx
...
This PR introduces the generation of documentation based on
this excellent blog post: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/
It combines the tools Sphinx, Doxygen and Breathe to generate good
looking HTML documentation conveniently which can be hosted easily.
The helper scripts were unified and there is now one helper.py script
which can be used to create, build and open both tests and documentation.
"./helper.py -h" can be used to get the different options.
This PR also contains some smaller fixes which were necessary for the docs
to build
2021-12-01 11:17:28 +01:00
