-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: document code with doxygen, breathe, and sphinx_csharp
- Loading branch information
1 parent
172e61d
commit 1c1a97f
Showing
9 changed files
with
3,006 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,10 @@ | ||
breathe==4.35.0 | ||
furo==2023.9.10 | ||
m2r2==0.3.3.post2 | ||
rstcheck[sphinx]==6.2.0 | ||
rstfmt==0.0.14 | ||
Sphinx==7.2.6 | ||
sphinx-copybutton==0.5.2 | ||
|
||
# install submodules | ||
./third-party/sphinx-csharp |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
Source Code | ||
=========== | ||
Our source code is documented using the `standard documentation guidelines | ||
<https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments>`__. | ||
|
||
Source | ||
------ | ||
|
||
.. doxygennamespace:: Jellyfin::Plugin::Themerr | ||
:members: | ||
:protected-members: | ||
:private-members: | ||
:undoc-members: | ||
|
||
.. Ideally, we would use `doxygenfile` with `:allow-dot-graphs:`, but sphinx complains about duplicated namespaces... | ||
.. | ||
.. .. toctree:: | ||
.. :caption: Jellyfin.Plugin.Themerr | ||
.. :maxdepth: 1 | ||
.. :glob: | ||
.. | ||
.. Jellyfin.Plugin.Themerr/* | ||
.. | ||
.. .. toctree:: | ||
.. :caption: Jellyfin.Plugin.Themerr/Api | ||
.. :maxdepth: 1 | ||
.. :glob: | ||
.. | ||
.. Jellyfin.Plugin.Themerr/Api/* | ||
.. | ||
.. .. toctree:: | ||
.. :caption: Jellyfin.Plugin.Themerr/Configuration | ||
.. :maxdepth: 1 | ||
.. :glob: | ||
.. | ||
.. Jellyfin.Plugin.Themerr/Configuration/* | ||
.. | ||
.. .. toctree:: | ||
.. :caption: Jellyfin.Plugin.Themerr/ScheduledTasks | ||
.. :maxdepth: 1 | ||
.. :glob: | ||
.. | ||
.. Jellyfin.Plugin.Themerr/ScheduledTasks/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule sphinx-csharp
added at
1e4cf5