[docs] Reduce width; code highlighting changes, installation guide improvements, prompt blocks #863
Conversation
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
Was 80em, but that leaves too high line lengths.
Not really useful at the moment, might get added back later.
The "trac" pygments style is not as readable and doesn't fit as well with the overall blue-ish white theme.
`easy_install` has ceased enough in popularity that it'd just be confusing to mention.
Aligns with below sections in the document. Isso is py3-only.
Those have been moved to the "Writing documentation" section and clutter the installation guide unnecessarily - especially since the manpage generation was been removed.
Use `$` instead of `~>` for consistency and use the `(.venv) $` prefix to denote commands that need to be run inside a virtualenv. Also converge on using `console` as a block "language" so that the "prompt" characters such as `$` are rendered as not user-selectable, easing copy-paste.
"Prompt" characters such as `$` are rendered as not user-selectable, easing copy-paste.
ix5
added
docs
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.
docs: css: Reduce content width to 70em
Was 80em, but that leaves too high line lengths.
docs: theme: Remove 'News' navlink
Not really useful at the moment, might get added back later.
docs: conf: Use abap pygments style
The "trac" pygments style is not as readable and doesn't fit as well with the overall blue-ish white theme.
docs: css: Lighter code bg, use vars
docs: install: Remove mentions of easy_install
easy_installhas ceased enough in popularity that it'd just be confusing to mention.docs: install: Explicitly mention py3 packages
Aligns with below sections in the document. Isso is py3-only.
docs: install: Drop docs instructions
Those have been moved to the "Writing documentation" section and clutter the installation guide unnecessarily - especially since the manpage generation was been removed.
[nit] docs: install: Bump py to 3.6 in from-source
docs: install, quickstart: Unify venv/shell syntax
Use
$instead of~>for consistency and use the(.venv) $prefix to denote commands that need to be run inside a virtualenv.Also converge on using
consoleas a block "language" so that the "prompt" characters such as$are rendered as not user-selectable, easing copy-paste.docs/contrib: docs: Use and document console blocks
docs: css: Make console prompts non-selectable
"Prompt" characters such as
$are rendered as not user-selectable, easing copy-paste.