Skip to content

Commit

Permalink
docs: document code with doxygen, breathe, and sphinx_csharp
Browse files Browse the repository at this point in the history
  • Loading branch information
ReenigneArcher committed Dec 17, 2023
1 parent 172e61d commit 018c5a8
Show file tree
Hide file tree
Showing 10 changed files with 3,019 additions and 3 deletions.
4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "third-party/sphinx-csharp"]
path = third-party/sphinx-csharp
url = https://github.com/rogerbarton/sphinx-csharp.git
branch = master
11 changes: 9 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,21 @@ version: 2

# Set the version of Python
build:
os: ubuntu-20.04
os: ubuntu-22.04
tools:
python: "3.10"
python: "3.11"
apt_packages:
- graphviz # required to build diagrams
jobs:
post_build:
- rstcheck -r . # lint rst files
# - rstfmt --check --diff -w 120 . # check rst formatting

# submodules required to install sphinx-csharp
submodules:
include: all
recursive: true

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
Expand Down
8 changes: 8 additions & 0 deletions .rstcheck.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@

[rstcheck]
ignore_directives =
doxygenindex,
doxygennamespace,
include,
interface,
mdinclude,
todo,

ignore_roles =
idxr,
interface,
prop,
3 changes: 2 additions & 1 deletion Jellyfin.Plugin.Themerr/Api/ThemerrController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ public class ThemerrController : ControllerBase

/// <summary>
/// Downloads all Movie theme songs.
///
/// A response code of 204 indicates that the download has started successfully.
/// </summary>
/// <response code="204">Theme song download started successfully.</response>
/// <returns>A <see cref="NoContentResult"/> indicating success.</returns>
[HttpPost("DownloadMovies")]
[ProducesResponseType(StatusCodes.Status204NoContent)]
Expand Down
Loading

0 comments on commit 018c5a8

Please sign in to comment.