Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: drop sphinx and use doxygen exclusively #2932

Merged

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Jul 30, 2024

Description

This PR drops sphinx/python docs and will use doxygen exclusively.

Todo:

see: LizardByte/libdisplaydevice#71

Screenshot

Issues Fixed or Closed

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

@ReenigneArcher ReenigneArcher force-pushed the docs-drop-sphinx-and-use-doxygen-exclusively branch from 1641594 to 43ac7fd Compare July 30, 2024 02:41
@ReenigneArcher ReenigneArcher marked this pull request as draft July 30, 2024 02:41
@ReenigneArcher ReenigneArcher force-pushed the docs-drop-sphinx-and-use-doxygen-exclusively branch 7 times, most recently from a6b73db to 88f24f5 Compare July 30, 2024 03:21
Copy link

codecov bot commented Jul 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 9.65%. Comparing base (adf068e) to head (abcfe32).
Report is 138 commits behind head on master.

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #2932   +/-   ##
======================================
  Coverage    9.65%   9.65%           
======================================
  Files          97      97           
  Lines       17557   17557           
  Branches     8230    8230           
======================================
  Hits         1696    1696           
  Misses      12998   12998           
  Partials     2863    2863           
Flag Coverage Δ
Linux 7.16% <ø> (ø)
Windows 5.08% <ø> (ø)
macOS-12 10.29% <ø> (ø)
macOS-13 10.21% <ø> (+0.01%) ⬆️
macOS-14 10.52% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@ReenigneArcher ReenigneArcher force-pushed the docs-drop-sphinx-and-use-doxygen-exclusively branch from 88f24f5 to dbce5b6 Compare July 30, 2024 21:19
@ReenigneArcher ReenigneArcher force-pushed the docs-drop-sphinx-and-use-doxygen-exclusively branch 4 times, most recently from a54f831 to 31c9c08 Compare July 30, 2024 22:50
@ReenigneArcher ReenigneArcher force-pushed the docs-drop-sphinx-and-use-doxygen-exclusively branch 8 times, most recently from e5795ad to 81b7864 Compare July 31, 2024 21:44
@ReenigneArcher ReenigneArcher force-pushed the docs-drop-sphinx-and-use-doxygen-exclusively branch 3 times, most recently from 4d4082c to 5656e4b Compare August 1, 2024 13:41
@ReenigneArcher ReenigneArcher force-pushed the docs-drop-sphinx-and-use-doxygen-exclusively branch 3 times, most recently from f1adba0 to 729399c Compare August 2, 2024 14:56
@ReenigneArcher ReenigneArcher force-pushed the docs-drop-sphinx-and-use-doxygen-exclusively branch from 729399c to 9a44380 Compare August 3, 2024 02:17
@ReenigneArcher ReenigneArcher force-pushed the docs-drop-sphinx-and-use-doxygen-exclusively branch 16 times, most recently from e2d4432 to 27eedcd Compare August 5, 2024 17:27
@ReenigneArcher ReenigneArcher force-pushed the docs-drop-sphinx-and-use-doxygen-exclusively branch from 27eedcd to abcfe32 Compare August 5, 2024 18:11
@ReenigneArcher ReenigneArcher marked this pull request as ready for review August 5, 2024 18:39
@ReenigneArcher ReenigneArcher enabled auto-merge (squash) August 5, 2024 18:42
@ReenigneArcher
Copy link
Member Author

@cgutman FYI

@ReenigneArcher ReenigneArcher merged commit 4bd521b into master Aug 5, 2024
47 checks passed
@ReenigneArcher ReenigneArcher deleted the docs-drop-sphinx-and-use-doxygen-exclusively branch August 5, 2024 18:44
KuleRucket pushed a commit to KuleRucket/Sunshine that referenced this pull request Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant