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(hrefs): update readthedocs hrefs #3476

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Dec 22, 2024

Description

This PR updates hrefs to docs, mainly so they will continue to work with the doxygen version of the docs.

This PR should not be merged until right before the next stable release.

Additionally, directly before this is merged, we need to update a setting on readthedocs, to not put docs under an en subdirectory (also for the .github repo).

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 added this to the stable release milestone Dec 22, 2024
@ReenigneArcher ReenigneArcher force-pushed the docs/hrefs/update-readthedocs-hrefs branch from cfb037d to 1f8c1f9 Compare December 22, 2024 04:24
Copy link

codecov bot commented Dec 22, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 10.30%. Comparing base (a7f6411) to head (77315f9).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
src/platform/linux/kmsgrab.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##           master    #3476     +/-   ##
=========================================
  Coverage   10.30%   10.30%             
=========================================
  Files          90       90             
  Lines       16130    16130             
  Branches     7655     7655             
=========================================
  Hits         1662     1662             
+ Misses      13911    11918   -1993     
- Partials      557     2550   +1993     
Flag Coverage Δ
Linux 9.68% <0.00%> (ø)
Windows 10.77% <ø> (ø)

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

Files with missing lines Coverage Δ
src/platform/linux/kmsgrab.cpp 3.51% <0.00%> (ø)

... and 33 files with indirect coverage changes

@ReenigneArcher ReenigneArcher force-pushed the docs/hrefs/update-readthedocs-hrefs branch from 1f8c1f9 to c8b157b Compare December 24, 2024 01:45
@ReenigneArcher ReenigneArcher force-pushed the docs/hrefs/update-readthedocs-hrefs branch from c8b157b to b9f0061 Compare January 12, 2025 21:56
@ReenigneArcher ReenigneArcher self-assigned this Jan 14, 2025
@ReenigneArcher ReenigneArcher force-pushed the docs/hrefs/update-readthedocs-hrefs branch 2 times, most recently from 15a1e72 to 127e6fb Compare January 14, 2025 02:20
@ReenigneArcher ReenigneArcher marked this pull request as ready for review January 14, 2025 02:49
@ReenigneArcher ReenigneArcher force-pushed the docs/hrefs/update-readthedocs-hrefs branch from 127e6fb to 77315f9 Compare January 14, 2025 02:51
@ReenigneArcher ReenigneArcher merged commit 820180c into master Jan 14, 2025
36 of 37 checks passed
@ReenigneArcher ReenigneArcher deleted the docs/hrefs/update-readthedocs-hrefs branch January 14, 2025 03:34
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