Skip to content

Commit

Permalink
docs: Support Markdown file type (closes #208) (#215)
Browse files Browse the repository at this point in the history
* dependencies: Sphinx 2.0.1 -> 2.2.1

Signed-off-by: Justin W. Flory <git@jwf.io>

* docs: Bump version string v1.2.2 -> v1.3.3

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>

* docs: Support Markdown file type (closes #208)

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>
  • Loading branch information
jwflory committed Nov 3, 2019
1 parent 666e072 commit 962abbc
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 42 deletions.
74 changes: 37 additions & 37 deletions docs/Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 15 additions & 5 deletions docs/conf.py
Expand Up @@ -33,7 +33,13 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.imgmath']
extensions = [
'recommonmark',
'sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.imgmath',
'sphinx.ext.viewcode',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -42,14 +48,18 @@
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'RITlug TeleIRC'
copyright = '2018-2019 CC-BY SA 4.0'
copyright = '2018-2019 CC BY-SA 4.0'
author = \
'Mark Repka, ' \
'Seth Hendrick, ' \
Expand All @@ -64,9 +74,9 @@
# built documents.
#
# The short X.Y version.
version = '1.2.2'
version = '1.3'
# The full version, including alpha/beta/rc tags.
release = '1.2.2'
release = '1.3.3'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down

0 comments on commit 962abbc

Please sign in to comment.