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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 3 commits into from Nov 3, 2019
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17969ee
dependencies: Sphinx 2.0.1 -> 2.2.1
jwflory Nov 3, 2019
09d04b0
docs: Bump version string v1.2.2 -> v1.3.3
jwflory Nov 3, 2019
a533fcf
docs: Support Markdown file type (closes #208)
jwflory Nov 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
74 changes: 37 additions & 37 deletions docs/Pipfile.lock
View file
Open in desktop

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
View file
Open in desktop
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