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

mkdocs: Set site_url #1215

Merged
merged 1 commit into from Jun 25, 2021
Merged

mkdocs: Set site_url #1215

merged 1 commit into from Jun 25, 2021

Conversation

JayH5
Copy link
Member

@JayH5 JayH5 commented Jun 24, 2021

I'm hoping this fixes #1212, but tbh it is a bit difficult to test. I can confirm that this warning when running scripts/docs is gone:

❯ scripts/docs
+ venv/bin/mkdocs serve
INFO     -  Building documentation...
WARNING  -  Config value: 'site_url'. Warning: This option is now required. Set to a
            valid URL or an empty string to avoid an error in a future release.
WARNING  -  Config value: 'site_url'. Warning: The 'use_directory_urls' option has been
            disabled because 'site_url' contains an empty value. Either define a valid
            URL for 'site_url' or set 'use_directory_urls' to False.
INFO     -  Cleaning site directory
INFO     -  Documentation built in 1.62 seconds
INFO     -  [21:55:26] Serving on http://127.0.0.1:8000/

...and that sitemap.xml makes sense when running locally. Currently, https://www.starlette.io/sitemap.xml has bad loc attributes (they're all None).

w.r.t. the HTTPS redirect issue (there being no redirect), I don't have sufficient permissions on GitHub to fix that as per these instructions: https://docs.github.com/en/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https

I'm hoping that I can just run mkdocs gh-deploy --force after this is merged to deploy new docs but will see.

@JayH5 JayH5 requested a review from a team June 24, 2021 21:13
@JayH5
Copy link
Member Author

JayH5 commented Jun 24, 2021

I've gone ahead and run mkdocs gh-deploy --force to get the sitemap fixed as this seems fairly urgent. The broken links reported in #1212 are now fixed.

@JayH5 JayH5 merged commit 6626636 into master Jun 25, 2021
@JayH5 JayH5 deleted the jh/fix-docs branch June 25, 2021 07:46
@graingert graingert mentioned this pull request Jul 4, 2021
11 tasks
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.

Starlette docs has dead links, broken sitemap and missing redirection for http://
2 participants