Docs: update installation and configuration instructions #1697
Conversation
This file contains 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
…a cleaner table structure for explaining the various parameters Include a custom `layout.html` and `css` file to make the tables responsive and wrap long text.
|
Looks like there are a few things to fix in the docs build. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Some updates to the
installationandconfigurationsections, fixing some typos and rewording some paragraphs so they can be better understood by newcomers.I added a custom stylesheet, inspired by OpenShot/openshot-qt#1272, to render the tables as responsive elements, wrapping the text content within.
I found out that ReadTheDocs can preview the changes from a PR, this may come in handy to preview them before merging in
dev: https://docs.readthedocs.io/en/stable/guides/pull-requests.html