-
Notifications
You must be signed in to change notification settings - Fork 438
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
[docs] [MAJOR] Re-arrange, add a few missing pages to be filled in #848
Merged
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
ix5
added
docs
Documentation of the project
improvement
Not a new feature, but makes Isso more pleasant to use
labels
Apr 29, 2022
ix5
changed the title
[docs] Re-arrange, add a few missing pages to be filled in
[docs] [MAJOR] Re-arrange, add a few missing pages to be filled in
Apr 29, 2022
Needed for later changes which utilize standard sphinx features rather than Isso's hacked-together hardcoded ways.
Rather than a hardcoded one in the sidebar.
This is large change that sorts docs pages into a different hierarchy. Needed redirects will follow in later commits. Several docs are placeholders for now, to be filled with content later.
To quickly demonstrate and verify a few features of the `_isso` theme, such as warning labels.
Add a mapping of moved pages for which the `reredirects` sphinx extension will create 301/JS redirects for. Adding the extension will follow in a later commit.
This extension, imported from the `sphinx_reredirects` package, creates 301/JS redirects for moved pages.
These are little warnings or notes, presented as boxes.
Those documents have moved, point to their new locations
And invite people to contribute while showing them how.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
docs
Documentation of the project
improvement
Not a new feature, but makes Isso more pleasant to use
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.
Bit of a massive PR but these changes have been resting on my hard drive for way too long.
Changes can be seen live at isso-comments.github.io. Redirects should work fine there (but will need custom nginx rules, when posativ finds some time to upload new docs).
docs: Re-arrange contents, add placeholders
This is large change that sorts docs pages into a different hierarchy.
Several docs are placeholders for now, to be filled with content later.
Adjust cross-references to new locations, fix inline toctree links
Also: docs: conf: Add redirects mapping
Add a mapping of moved pages for which the
reredirects
sphinx extension will create 301/JS redirects for.docs: Annotate missing/incomplete pages with TODOs
And invite people to contribute while showing them how.
docs: conf: Fix favicon path, future-proof toc doc
Makefile: Add css target for docs
docs: css: Adjust fonts, colors, margins, remove >h2
docs: site.scss: Add admonition styling
These are little warnings or notes, presented as boxes.
docs: Add redirects extension
This extension, imported from the
sphinx_reredirects
package, creates 301/JS redirects for moved pages.Also: docs: _ext: Emit dirhtml source files
docs: Add hidden theme-testing page
To quickly demonstrate and verify a few features of the
_isso
theme, such as warning labels.docs: Remove theme cruft, update styles
docs: Use standard sphinx table-of-content
Rather than a hardcoded one in the sidebar.
docs: conf,theme.conf: More sensible defaults
Needed for later changes which utilize standard sphinx features rather than Isso's hacked-together hardcoded ways.