Update to the latest sphinx stack - #224
Open
wolsen wants to merge 10 commits into
Open
Conversation
Refactor the layout of the project to move the documentation source files to the docs directory. This is in preparation for migrating to the new sphinx-stack. Signed-off-by: Billy Olsen <billy.olsen@canonical.com>
Migrate to the Canonical sphinx-stack 2.0. Signed-off-by: Billy Olsen <billy.olsen@canonical.com>
Update the documentation for contributors to the documentation in order to provide guidanace on how to contribute. Signed-off-by: Billy Olsen <billy.olsen@canonical.com>
The .custom_wordlist.txt and .wordlist.txt were missed when refactoring the documentation into the docs directory. Move them into their proper location in the docs directory. Additionally, the custom_conf.py file should have been removed and wasn't. Signed-off-by: Billy Olsen <billy.olsen@canonical.com>
Refactor the gpu passthrough documentation to remove non-inclusive words. Ignore the configuring-sriov.rst file for the time being as the command option itself in the CLI is using non-inclusive language and needs to be updated after the CLI prompt itself is fixed. Signed-off-by: Billy Olsen <billy.olsen@canonical.com>
The linkchecker caught some true failures of links that have changed. Update the links. For the https://canonical.com/openstack#contact-us link, it gets ignored in the linkchecker as the anchor is added as part of javascript that is not rendered when the linkchecker runs. Signed-off-by: Billy Olsen <billy.olsen@canonical.com>
Update the .readthedocs.yaml file to use the one from the Canonical sphinx-stack. Signed-off-by: Billy Olsen <billy.olsen@canonical.com>
Update the custom wordlist and some of the documentation to remove words identified as being misspelled. Additionally, the cheat sheets are useful for getting started but they fail some checks so these are removed from the repository. Signed-off-by: Billy Olsen <billy.olsen@canonical.com>
Update the home page to use the same grid style that is used in the sphinx stack documentation and reference. This offers a nicer grid view that has hover-over highlighting for users. Signed-off-by: Billy Olsen <billy.olsen@canonical.com>
The Test Sphinx Stack test in the github action tests the same thing as the automatic doc checks from the canonical/documentation-workflows documentation-checks. Remove it. Signed-off-by: Billy Olsen <billy.olsen@canonical.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update the documentation framework to use the current sphinx-stack project from Canonical. This brings the documentation repository stack up-to-date with the current standard for Canonical documentation.
Jira: OPEN-4633