-
Notifications
You must be signed in to change notification settings - Fork 12
Adding the Sphinx sitemap extension #32
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
Conversation
|
@scriptautomate-bc please review. Thanks |
scriptautomate-bc
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rebase with latest from main, as I've made some updates to how version should be latest, among other changes (#33). My changes in main, plus my suggestion feedback to your PR, I think should prep it for working.
After rebasing and applying my suggestions, make sure to do a pre-commit run --all with all of these updates locally, just in case any autofixes need to be applied.
On your local system, make sure to confirm that the generated /docs/_build/html/sitemaps.xml lists URLs in the expected format of endpoint pages under https://docs.saltproject.io/salt/install-guide/en/latest/*.
|
Apologies for this, I mist have skipped it. |
scriptautomate-bc
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for this, I mist have skipped it. I have updated the baseurl, however I am not sure of the format for the generated sitemap.
You still have not done everything asked of you in this PR. Please review my prior request in this PR that you haven't completed:
e91a13c to
bf624cb
Compare
scriptautomate-bc
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've applied changes needed. Merging after CI passes.
Fixes: #30
I successfully created a local version on my laptop. I then updated the
conf.pywith the extension name and thebaseurland then updated the requirements.txt file with the name of the extension.I got an error
File "C:\Users\USER\Desktop\Open Source\salt-install-guide\.nox\docs-html-gen_sitevars-true-clean-true\Lib\site-packages\sphinx\registry.py", line 544, in load_extension raise ExtensionError( __('Could not import extension %s') % extname, err ) from err sphinx.errors.ExtensionError: Could not import extension sphinx-sitemap (exception: No module named 'sphinx-sitemap')I am sure I did everything well.