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: Support Markdown file type (closes #208) #215

Merged
merged 3 commits into from Nov 3, 2019

Conversation

@jwflory
Copy link
Member

jwflory commented Nov 3, 2019

This PR makes a collection of changes to our docs. To highlight the commit message summaries:

  • dependencies: Sphinx 2.0.1 -> 2.2.1 — c2cd9a9
  • docs: Bump version string v1.2.2 -> v1.3.3 — 50158a1
  • docs: Support Markdown file type (closes #208) — 5b9e091

A future PR might convert over our existing ReStructuredText docs to Markdown, for simplicity.

@jwflory jwflory requested a review from RITlug/teleirc-developers-commit-access Nov 3, 2019
@jwflory jwflory self-assigned this Nov 3, 2019
@jwflory jwflory added this to In progress in TeleIRC development via automation Nov 3, 2019
@Tjzabel
Tjzabel approved these changes Nov 3, 2019
Copy link
Member

Tjzabel left a comment

Looks good to me!

jwflory added 3 commits Nov 3, 2019
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 #208.

Signed-off-by: Justin W. Flory <git@jwf.io>
@jwflory jwflory force-pushed the jwflory:208/docs-markdown-support branch from 5b9e091 to a533fcf Nov 3, 2019
@jwflory jwflory merged commit 962abbc into RITlug:master Nov 3, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
TeleIRC development automation moved this from In progress to Done Nov 3, 2019
@jwflory jwflory deleted the jwflory:208/docs-markdown-support branch Nov 3, 2019
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
Projects
2 participants
You can’t perform that action at this time.