Skip to content

Commit

Permalink
some changes in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benmaier committed Mar 27, 2019
1 parent 4f3d187 commit add3619
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 6 deletions.
27 changes: 27 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: docs/requirements.txt

submodules:
include: all
recursive: true
12 changes: 6 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# _tacoma documentation build configuration file, created by
# _netwulf documentation build configuration file, created by
# sphinx-quickstart on Fri Feb 26 00:29:33 2016.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -261,7 +261,7 @@ def __getattr__(cls, name):
#html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.
htmlhelp_basename = 'tacomadoc'
htmlhelp_basename = 'netwulfdoc'

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

Expand All @@ -283,7 +283,7 @@ def __getattr__(cls, name):
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'tacoma.tex', u'tacoma Documentation',
(master_doc, 'netwulf.tex', u'netwulf Documentation',
u'Benjamin F. Maier', 'manual'),
]

Expand Down Expand Up @@ -313,7 +313,7 @@ def __getattr__(cls, name):
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'tacoma', u'tacoma Documentation',
(master_doc, 'netwulf', u'netwulf Documentation',
[author], 1)
]

Expand All @@ -327,8 +327,8 @@ def __getattr__(cls, name):
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'tacoma', u'tacoma Documentation',
author, __author__, 'One line description of project.',
(master_doc, 'netwulf', u'netwulf Documentation',
author, __author__, 'An interactive network visualization tool for Python.',
'Miscellaneous'),
]

Expand Down

0 comments on commit add3619

Please sign in to comment.