Upgrade Docs#79
Merged
Merged
Conversation
Replaces the access to `discord.utils._MissingSentinel` with a simple boolean flag. This has the benefit of behaving more nicely with our doc generation. Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
Add the releases-based changelog system back, and migrate the old changelog entries. Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
Adds the sphinx-multiversion package to be used for generating docs for all versions of the project, not just the latest. This includes all the necessary configuration to make it work cleanly. Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
Add a brief explanation about each item in the docs folder, to help contributors navigate and understand what each part does. Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
✅ Deploy Preview for bot-core ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Deleted CHANGELOG.md in favor of the changelog in the docs. Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
HassanAbouelela
force-pushed
the
upgrade-docs
branch
from
a8d66ed to
8bf5603
Compare
Changes the behavior of `BUILD_DOCS_FOR_HEAD` to add only the current branch to the build whitelist, instead of all branches. Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
HassanAbouelela
force-pushed
the
upgrade-docs
branch
from
b3b7706 to
ebedca3
Compare
Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
HassanAbouelela
force-pushed
the
upgrade-docs
branch
from
ebedca3 to
4c32cca
Compare
Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
HassanAbouelela
force-pushed
the
upgrade-docs
branch
5 times, most recently
from
17c0416 to
504d6ad
Compare
Contributor
Author
|
I've finally got CI working, and the PR is almost ready. If you navigate to the build right now, you won't actually see anything because that depends on the |
Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
HassanAbouelela
force-pushed
the
upgrade-docs
branch
from
504d6ad to
9934436
Compare
Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
Removes unnecessary `depends-on` to speed up builds. Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
Contributor
Author
|
Alright, generated some demos on my fork. You can see the docs here:
Make sure to see the |
Co-authored-by: Chris Lovering <chris.lovering.95@gmail.com> Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
ChrisLovering
approved these changes
May 30, 2022
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
2 participants
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.
This PR upgrades our docs in two aspects:
release-based changelogs (ed4b2fb). They were originally removed due to not wanting to maintain a list of versions, but we ended up doing that anyways. This is nicer for users than the changelog.md file we are maintainingWhile reviewing the multiversion changes, the following two limitations might be important to keep in mind to understand why it's as complicated as it is:
-c project/path/docs/conf.py, as opposed to-c historical_version/docs/conf.py), which means we can't assume anything about the state of the project. Things like version, commit information, etc need to be obtained through some other method.