Move to self-hosted documentation #1270
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
|
How about renaming the namespace to |
Merged
|
@ashmaroli I'm not sure if there's a consensus more broadly amongst the Ruby community but I looked at the tasks that were added by Bundler and the pattern seemed to be I added in the bit about not being able to automatically publish the documentation but I'm not too worried about that at this stage. It was more a note in case the expectation was that the documentation would magically get updated. |
pyrmont
force-pushed
the
feature.self-hosted-docs
branch
from
cc834c1 to
d0011a4
Compare
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.
Rouge's official documentation is hosted on RubyDoc.info. Recently, that site has frequently responded with 500 errors. This is problematic for various reasons, not least of which is it makes it difficult to refer potential contributors to the documentation for help in creating new lexers.
This PR provides the facility to integrate self-hosted documentation into Rouge's development process. The documentation is hosted on GitHub at present but this could be changed at a later point if desired.
It should be noted that the documentation generated still needs to be pushed to the docs repo manually.