Skip to content
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
merged 17 commits into from
Apr 30, 2022

Conversation

ix5
Copy link
Member

@ix5 ix5 commented Apr 29, 2022

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.

@ix5 ix5 added docs Documentation of the project improvement Not a new feature, but makes Isso more pleasant to use labels Apr 29, 2022
@ix5 ix5 added this to the 0.13 milestone Apr 29, 2022
@ix5 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
ix5 added 16 commits April 30, 2022 15:11
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.
@ix5 ix5 merged commit f0c54c5 into isso-comments:master Apr 30, 2022
@ix5 ix5 deleted the docs-overhaul branch April 30, 2022 14:27
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant