docs: Support Markdown file type (closes #208) #215
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
jwflory
added
improvement
Signed-off-by: Justin W. Flory <git@jwf.io>
This should be documented somewhere as part of the release process. I didn't realize our docs were publishing for older versions. Signed-off-by: Justin W. Flory <git@jwf.io>
This commit adds Markdown support to our documentation. Files that end in a `.md` extension will be detected by Sphinx as documentation to render in `docs/`. We can write in whatever format we wish. Closes RITlug#208. Signed-off-by: Justin W. Flory <git@jwf.io>
jwflory
force-pushed
the
208/docs-markdown-support
branch
from
5b9e091
to
a533fcf
Compare
jwflory
added a commit
to jwflory/teleirc
that referenced
this pull request
Nov 4, 2019
This commit switches our Travis CI builds over to a matrix build system. In addition to performing the standard unit test suite for NodeJS, it will also kick up a VM to build and test our docs. This is a fairly lightweight way to guarantee that our docs are building. Also, you will notice this commit is failing! That is expected. The `recommonmark` dependency was not added in RITlug#215, but it was added in PR RITlug#217. Once that PR merges, this CI test will pass again. Signed-off-by: Justin W. Flory <git@jwf.io>
jwflory
added a commit
to jwflory/teleirc
that referenced
this pull request
Nov 4, 2019
This commit switches our Travis CI builds over to a matrix build system. In addition to performing the standard unit test suite for NodeJS, it will also kick up a VM to build and test our docs. This is a fairly lightweight way to guarantee that our docs are building. Also, you will notice this commit is failing! That is expected. The `recommonmark` dependency was not added in RITlug#215, but it was added in PR RITlug#217. Once that PR merges, this CI test will pass again. Signed-off-by: Justin W. Flory <git@jwf.io>
jwflory
added a commit
that referenced
this pull request
Nov 4, 2019
This commit switches our Travis CI builds over to a matrix build system. In addition to performing the standard unit test suite for NodeJS, it will also kick up a VM to build and test our docs. This is a fairly lightweight way to guarantee that our docs are building. Also, you will notice this commit is failing! That is expected. The `recommonmark` dependency was not added in #215, but it was added in PR #217. Once that PR merges, this CI test will pass again. Signed-off-by: Justin W. Flory <git@jwf.io>
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.
This PR makes a collection of changes to our docs. To highlight the commit message summaries:
A future PR might convert over our existing ReStructuredText docs to Markdown, for simplicity.