Various minor fixes for the sphinx docs #1935

ZedThree · 2020-03-03T11:09:31Z

No description provided.

Sphinx tries to parse these as links, but they're really example strings

Single backticks are interpreted as Sphinx links, need double backticks for code literal

Whole file needs update really!

dschwoerer

Reduces the number of Errors from 1168 to 1116 and the number of Warnings from 2023 to 1986 👍

ZedThree added 8 commits March 3, 2020 10:51

Remove unnecessary doxygen \file command

811c3bb

Fix typo in doxygen parameter command

3d2e2c3

Replace backticks with quotes in boutcore examples

ca687f2

Sphinx tries to parse these as links, but they're really example strings

Fix some rst code literals

65cacd3

Single backticks are interpreted as Sphinx links, need double backticks for code literal

Use full name of python function so Sphinx finds it

78b4c7c

Delete some removed files from code layout docs

b967053

Whole file needs update really!

Fix wrong section ref name

27cc72a

Fix wrong number of spaces in indent

c97205c

ZedThree added this to the BOUT-5.0 milestone Mar 3, 2020

dschwoerer approved these changes Mar 3, 2020

View reviewed changes

ZedThree merged commit 6539090 into next Mar 3, 2020

ZedThree deleted the docs-rst-fixes branch November 30, 2021 14:14

Provide feedback