Code

Fix various documentation issues#2844

Code

Open

ZedThree wants to merge 37 commits intonextboutproject/BOUT-dev:nextfrom fix-docs-warningsboutproject/BOUT-dev:fix-docs-warningsCopy head branch name to clipboard

+563-3,198

Commits

Commits on Jan 22, 2024

• Docs: Fix some double-backtick issues

  ZedThree

  committed
  3f311e0

  Copy full SHA for 3f311e0

• Docs: Update code layout

  Show description for 0bc5206
  ZedThree

  committed
  0bc5206

  Copy full SHA for 0bc5206

• Docs: Fix underline too short

  ZedThree

  committed
  297b284

  Copy full SHA for 297b284

• Docs: Don't include boutdata/boututils in docs

  ZedThree

  committed
  e6bc5c5

  Copy full SHA for e6bc5c5

• Docs: Fix reference link

  ZedThree

  committed
  41da8a8

  Copy full SHA for 41da8a8

• Docs: Fix bullet points (require blank line before start)

  ZedThree

  committed
  96723d0

  Copy full SHA for 96723d0

• Docs: Fix wrong start of literal block

  ZedThree

  committed
  82c0708

  Copy full SHA for 82c0708

• Docs: Fix snippet for Scorep

  ZedThree

  committed
  e1591bc

  Copy full SHA for e1591bc

• Docs: Fix unknown role

  ZedThree

  committed
  dcb33f4

  Copy full SHA for dcb33f4

• Docs: Fix syntax for footnote

  ZedThree

  committed
  aa4a655

  Copy full SHA for aa4a655

• Fix a couple of "most vexing parse" that doxygen doesn't like

  ZedThree

  committed
  6640e94

  Copy full SHA for 6640e94

• Docs: Don't keep separate doxygen config for readthedocs

  ZedThree

  committed
  534fe4d

  Copy full SHA for 534fe4d

• Remove unused #define from petsc/slepc solvers

  ZedThree

  committed
  87ec9b0

  Copy full SHA for 87ec9b0

• Remove duplicate function pointer alias

  ZedThree

  committed
  1eb0c4f

  Copy full SHA for 1eb0c4f

• Remove unnecessary type alias

  Show description for f47847c
  ZedThree

  committed
  f47847c

  Copy full SHA for f47847c

• Docs: Add a couple of macros that doxygen should ignore

  ZedThree

  committed
  3ee4153

  Copy full SHA for 3ee4153

• Docs: Don't process .cxx files

  ZedThree

  committed
  bc43456

  Copy full SHA for bc43456

Commits on Jan 23, 2024

• Docs: Fix some latex equations in docstrings

  ZedThree

  committed
  37fea91

  Copy full SHA for 37fea91

Commits on Jan 24, 2024

• Tweak HypreLib docs

  Show description for f616515
  ZedThree

  committed
  f616515

  Copy full SHA for f616515

• Docs: Always set breathe config even if not generating files

  ZedThree

  committed
  de2599d

  Copy full SHA for de2599d

• Docs: Don't show header to include in docs

  ZedThree

  committed
  e30da8c

  Copy full SHA for e30da8c

• Docs: Don't run doxygen on python files

  ZedThree

  committed
  8e6c93d

  Copy full SHA for 8e6c93d

• Docs: Fix some egregiously outdated solver docs

  ZedThree

  committed
  709de64

  Copy full SHA for 709de64

• Docs: Fix some broken links now .cxx files aren't included

  ZedThree

  committed
  3ed4c7c

  Copy full SHA for 3ed4c7c

Commits on Jan 25, 2024

• Docs: Fix file-level docstrings not rendering correctly

  ZedThree

  committed
  d4559e3

  Copy full SHA for d4559e3

• Docs: Fix a bunch of LaTeX/codeblock rendering issues

  ZedThree

  committed
  8feddbb

  Copy full SHA for 8feddbb

• Apply clang-format changes

  

  ZedThree

  authored and

  github-actions[bot]

  committed
  678b41e

  Copy full SHA for 678b41e

Commits on Mar 1, 2024

• Merge branch 'next' of github.com:boutproject/BOUT-dev into fix-docs-warnings

  dschwoerer

  committed
  4be06d2

  Copy full SHA for 4be06d2

• Add MIT License text

  Show description for f6ae060
  dschwoerer

  committed
  f6ae060

  Copy full SHA for f6ae060

Commits on Mar 11, 2024

• Merge pull request #2875 from boutproject/fix-docs-warnings-db

  Show description for 54ee04e
  bendudson

  authored
  54ee04e

  Copy full SHA for 54ee04e

Commits on Mar 14, 2024

• Revert "Docs: Don't include boutdata/boututils in docs"

  Show description for d344f42
  dschwoerer

  committed
  d344f42

  Copy full SHA for d344f42

Commits on Mar 21, 2024

• Merge pull request #2881 from boutproject/fix-docs-warnings-db

  Show description for f665c24
  bendudson

  authored
  f665c24

  Copy full SHA for f665c24

Commits on Feb 14, 2025

• Merge branch 'next' into fix-docs-warnings

  Show description for 2e23e33
  ZedThree

  committed
  2e23e33

  Copy full SHA for 2e23e33

• Fix docstring and argument name for Div_a_Grad_perp

  ZedThree

  committed
  5bcdd6d

  Copy full SHA for 5bcdd6d

• docs: Fix some links to python docs

  ZedThree

  committed
  c1b4837

  Copy full SHA for c1b4837

• docs: Fix a couple of links to no longer included .cxx files

  ZedThree

  committed
  54535bd

  Copy full SHA for 54535bd

• Apply black changes

  

  ZedThree

  authored and

  github-actions[bot]

  committed
  6ea22a0

  Copy full SHA for 6ea22a0