Clean up documentation #2578
Merged
Clean up documentation #2578
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
agjohnson
added
PR: ready for review
PR: work in progress
|
These commits at least make |
| @@ -7,7 +7,7 @@ We pull your code from your Subversion_, Bazaar_, Git_, and Mercurial_ repositor | |||
| Then we build documentation and host it for you. | |||
| Think of it as *Continuous Documentation*. | |||
|
|
|||
| The code is open source, and `available on github`_. | |||
| The code is open source, and `available on GitHub`_. | |||
There was a problem hiding this comment.
This is a link, so the link text should be updated.
There was a problem hiding this comment.
Oops, good catch. Thanks.
| class Command(BaseCommand): | ||
| def handle(self, *args, **options): | ||
| for version in Version.objects.filter(slug=LATEST): | ||
| update_intersphinx(version.pk) |
There was a problem hiding this comment.
Any reason these files got deleted?
This ran haystack.autodiscover(), which was obsoleted by Haystack 2.0.0. In addition, search_sites itself was removed by Haystack 2.0.0 (HAYSTACK_SITECONF).
The task it refers to was removed in bf1a3d2, way back in 2014.
It refers to readthedocs.core.utils.copy_to_appservers, which was removed in 3c7f166, way back in 2014.
ops-docs previously removed in 105c566.
This uses Sphinx-style #: doc-comments, to retain a semblance of the current behaviour.
|
Thanks for this! |
ericholscher
removed
the
PR: work in progress
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.
Performs some spring-cleaning of the documentation, including:
This removes two management commands (
import_intersphinxandsync_builds) which no longer work and cannot be imported, because they rely on code which has already been deleted.