Matthias Mair
4869d0dab8
Add mermaid to docs ( #5405 )
...
* move devcontainer docs
* rename bare metal pages
* fix backlinks
* Add getting started for devs
* add mermaid
* include contrib in docs
* use another plugin
* include everything
* update doc checks
* fix install command
* Update mkdocs.yml
* Update mkdocs.yml
* Update starting.md
* Update starting.md
* Update starting.md
* extend requirements
* Update mkdocs.yml
* clean diff
* clean diff + check if it works
* fix CI check for custom tags
* clean md
2024-02-05 21:40:38 +11:00
Oliver
eeabc8d1f9
Pin mkdocs version to 1.4.3 ( #5388 )
...
- Updates to readthedocs policy mean that this needs to be pinned
- Moving to 1.5.0 breaks current documentation set
2023-08-02 22:52:01 +10:00
Matthias Mair
005c8341bf
Improve devdocs ( #4813 )
...
* move devcontainer docs
* rename bare metal pages
* fix backlinks
* Add getting started for devs
* add mermaid
* include contrib in docs
* use another plugin
* include everything
* update doc checks
* fix install command
* remove mermaid
* remove inclusion tag
* remove empty list item
* readd include-markdown
* use non-conflicting syntax for include
* fix table rendering in mkdocs
* make controbuting embedable
* re-add mermaid
* remove empty section
* resturcture
* remove mermaid again
2023-06-09 10:16:30 +10:00
Oliver
2ffd2354eb
Documentation integration ( #4653 )
...
* Add documentation under docs/ directory
* Add CI workflow for mkdocs configuration checking
* Add documentation issue template
* update pip-tools?
* Update .gitignore files
* Fix .gitignore rules
* Improve release notes page
* remove references to old repo
2023-04-22 22:40:29 +10:00
Oliver Walters
48cbd3be97
Remove (old) docs
2021-03-31 20:13:12 +11:00
Oliver Walters
53ec42af03
Generate documentation from makefile
...
- Had to change 'docs' to 'documentation' to prevent directory clash
2019-04-27 17:22:23 +10:00
Oliver Walters
ad3defffe3
Use sphinx-autoapi to generate documentation files
...
- Select which files to ignore
- Only display items with a docstring
2019-04-27 17:19:51 +10:00
Oliver Walters
e3440cbb90
Initialize sphinx documentation
...
- Change theme to sphinx_rtd_theme
- Ignore build files for docs
2019-04-27 16:09:52 +10:00
Oliver Walters
66cf8239fc
Add initial requirements for documentation
2019-04-27 15:44:46 +10:00
