mqtt-tools / mqttwarn

A highly configurable MQTT message router, where the routing targets are notification plugins, primarily written in Python.
https://mqttwarn.readthedocs.io/
Eclipse Public License 2.0
955 stars 183 forks source link

Combine GitHub Pages configuration with RTD-hosted documentation #663

Closed amotl closed 1 year ago

amotl commented 1 year ago

About

An attempt to let http://www.mqttwarn.net/ redirect to https://mqttwarn.readthedocs.io/.

Details

The GitHub Pages settings at ^1 have been adjusted to build from the repository root instead of the docs subdirectory, which now contains a Sphinx source tree instead of Jekyll, as before. As such, the CNAME control file has been moved to the repository root folder.

References

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (b19961b) 47.94% compared to head (7e2b6e3) 47.94%.

:exclamation: Current head 7e2b6e3 differs from pull request most recent head 10c898c. Consider uploading reports for the commit 10c898c to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #663 +/- ## ======================================= Coverage 47.94% 47.94% ======================================= Files 81 81 Lines 3917 3917 ======================================= Hits 1878 1878 Misses 2039 2039 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `47.94% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mqtt-tools#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

amotl commented 1 year ago

Hm. GitHub Pages still wants to build with Jekyll, see ^1. Maybe the new "GitHub Actions"-based configuration works better, as it offers the option for "Static HTML". Using an HTML-based redirect ^2 is not the best solution, but well, for now it should be made just work, right?

image image

amotl commented 1 year ago

It worked well.

Your site was last deployed to the github-pages environment by the Deploy static content to Pages workflow.

-- https://github.com/mqtt-tools/mqttwarn/settings/pages

With that workflow, the index.html got deployed to http://www.mqttwarn.net/. I like it.

jpmens commented 1 year ago

I couldn't for the life of me find the redirect; I'd forgotten about the CNAME file, thanks.