Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

### Added

- Added the LaTex manual template [Rene Gassmoeller; 2024-04-16; https://github.com/geodynamics/software_template/pull/8]

### Changed

- Switched the change log format from a self-written CHANGES file to the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format. [Rene Gassmoeller; 2024-03-29; https://github.com/geodynamics/software_template/pull/7]
Expand Down
13 changes: 6 additions & 7 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
This directory should contain the documentation for your software. For the
official manual template in LaTex, see:
https://github.com/geodynamics/best_practices/tree/master/software_manual_template
This directory should contain the documentation for your software.

For the official Sphinx documentation template see https://software-template.readthedocs.io,
which also includes information on how to build the documentation locally
in the /sphinx_template directory.
After building the documentation you can navigate to sphinx_template/_build/html
and double click on index.html to view the example offline.
in the `sphinx_template/` directory.
After building the documentation you can navigate to `sphinx_template/_build/html`
and open `index.html` to view the example offline.
For an alternative manual template written in LaTex see the `latex_template/` directory.

Keep in mind that your code should ideally also use an in-source documentation
system like doxygen or autodoc. We recommend writing your manual in LaTeX (like
the template linked above), Markdown, or reStructuredText.
the LaTex template), Markdown (like the Sphinx template), or reStructuredText.
Binary file added doc/latex_template/cover_image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading