Skip to content

Commit

Permalink
test
Browse files Browse the repository at this point in the history
  • Loading branch information
wemos committed Oct 28, 2019
1 parent cdd692b commit 0edf20c
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 2 deletions.
73 changes: 72 additions & 1 deletion docs/en/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
#
import os
import sys
import re

# sys.path.insert(0, os.path.abspath('.'))


Expand All @@ -37,6 +39,7 @@
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'nbsphinx',
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -45,12 +48,23 @@

source_suffix = '.rst'

master_doc = 'index'

# Tip from https://protips.readthedocs.io/git-tag-version.html to get version from tag
release = re.sub('^v', '', os.popen('git describe').read().strip())
# The short X.Y version.
version = release



# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']


pygments_style = 'sphinx'

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand All @@ -63,4 +77,61 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

master_doc = 'index'
# Output file base name for HTML help builder.
htmlhelp_basename = 'Wemosdoc'

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Wemosdoc.tex', u'WEMOS Documentation',
u'wemos.cc', 'manual'),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'wemosdoc', u'WEMOS Documentation',
[author], 1)
]


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Wemosdoc', u'WEMOS Documentation',
author, 'Wemosdoc', 'One line description of project.',
'Miscellaneous'),
]

linkcheck_anchors_ignore = ["/#!"]




4 changes: 3 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
sphinx
sphinx==1.7.9
sphinx-rtd-theme
breathe
nbsphinx
sphinx-notfound-page

0 comments on commit 0edf20c

Please sign in to comment.