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(configure): auto generate open urls #3163

Merged
merged 1 commit into from
Sep 11, 2024

Conversation

ReenigneArcher
Copy link
Member

@ReenigneArcher ReenigneArcher commented Sep 10, 2024

Description

  • Remove URLS from markdown headings, as they don't work with the side TOC. See screenshot.
  • Fix heading name for keybindings
  • Add input field for host address and port, allowing dynamic urls.

image

Todo:

  • Better display of input field... maybe in the navbar?
  • Button to change themes with dark/light mode change

Screenshot

Preview: https://lizardbyte--3163.org.readthedocs.build/projects/sunshine/en/3163/md_docs_2configuration.html

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

docs/configuration.js Fixed Show fixed Hide fixed
@ReenigneArcher ReenigneArcher force-pushed the docs/configure/auto-generate-open-urls branch 3 times, most recently from 94efefc to 1cc68fc Compare September 10, 2024 03:39
Copy link

codecov bot commented Sep 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 9.84%. Comparing base (8098df6) to head (25e0009).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##           master   #3163      +/-   ##
=========================================
+ Coverage    9.72%   9.84%   +0.11%     
=========================================
  Files          77     101      +24     
  Lines       14058   17974    +3916     
  Branches     6453    8401    +1948     
=========================================
+ Hits         1367    1769     +402     
- Misses      12028   13324    +1296     
- Partials      663    2881    +2218     
Flag Coverage Δ
Linux 7.27% <ø> (?)
Windows 5.07% <ø> (ø)
macOS-12 10.78% <ø> (-0.02%) ⬇️
macOS-13 10.71% <ø> (+0.01%) ⬆️
macOS-14 11.00% <ø> (+0.01%) ⬆️

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

see 59 files with indirect coverage changes

@ReenigneArcher ReenigneArcher force-pushed the docs/configure/auto-generate-open-urls branch 2 times, most recently from 2b1a228 to 432dffa Compare September 10, 2024 17:15
@ReenigneArcher
Copy link
Member Author

@cgutman Could you review this? You don't necessarily need to look at the code if you don't want, but I'd like your feedback on the rendered changes. https://lizardbyte--3163.org.readthedocs.build/projects/sunshine/en/3163/md_docs_2configuration.html

This also addresses something you brought previously about using localhost, as now it can be overridden.

@@ -629,7 +638,7 @@ editing the `conf` file in a text editor. Use the examples as reference.
</tr>
</table>

### [native_pen_touch](https://localhost:47990/config/#native_pen_touch)
### keybindings
Copy link
Member Author

@ReenigneArcher ReenigneArcher Sep 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This option isn't available in the UI, but a "Open" button will still be generated.

We should probably add this to the UI instead of excluding the open button from being created just for this case.

@Hazer is this something you can assist with?

Copy link

sonarcloud bot commented Sep 10, 2024

@ReenigneArcher ReenigneArcher added this to the stable release milestone Sep 11, 2024
@ReenigneArcher ReenigneArcher merged commit c892026 into master Sep 11, 2024
38 checks passed
@ReenigneArcher ReenigneArcher deleted the docs/configure/auto-generate-open-urls branch September 11, 2024 21:56
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