Small improvements to user manual
What does this MR do?
This MR fixes many dead links in the documentation, mainly by addition the remaining Markdown files from the top-level repository directory into the user manual. To that end, multiple additional symlinks have been created at /doc/markdown
.
The user manual currently builds without warnings from the .rst
files themselves.
Additionally, some formatting issues and wrong link directives have been fixed.
- Moved
COPYING.md
,CODE_OF_CONDUCT.md
,CONTRIBUTING.md
, andLICENSE
(download only) into user manual #177 (closed). - Fixed formatting of GMSH command #177 (closed).
- Fixed various links in existing documentation.
- Updated link to user manual in CLI.
- Added hints on cook book to
README.md
and user manual index. - Fix render of
README.md
tables in user manual.
Is there something that needs to be double checked?
No.
Can this MR be accepted?
-
Added/Updated documentation -
Pipeline passing -
Squash option set -
Delete branch option set -
Added entry to CHANGELOG.md
Assignee: If the Squash option is set, check/update the commit message right before merging!
Related issues
See #177 (closed)
Edited by Lukas Riedel