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

Fix docs build #27

Merged
merged 2 commits into from
Oct 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ python:
version: 3.7
install:
- requirements: docs/requirements.txt
- path: .
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ help:
@echo "test-all - run tests on every Python version with tox"
@echo "coverage - check code coverage quickly with the default Python"
@echo "docs - generate Sphinx HTML documentation, including API docs"
@echo "docs-live - rebuild the documentation when a change is detected"
@echo "api-docs - generate leicacam rst file for Sphinx HTML documentation"
@echo "release - package and upload a release to PyPI"
@echo "test-release - package and upload a release to test PyPI"
Expand Down Expand Up @@ -44,7 +45,10 @@ api-docs:
docs:
$(MAKE) -C docs clean
$(MAKE) -C docs html
open docs/_build/html/index.html

docs-live:
$(MAKE) -C docs clean
$(MAKE) -C docs livehtml

release: clean
python setup.py sdist bdist_wheel
Expand Down
3 changes: 3 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ dirhtml:
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

livehtml:
sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
Expand Down
22 changes: 12 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os
import datetime
import os
import sys

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand Down Expand Up @@ -48,8 +49,9 @@
master_doc = 'index'

# General information about the project.
project = u'leicacam'
copyright = u'2015, Arve Seljebu'
project = 'leicacam'
now = datetime.datetime.now()
copyright = '{}, Arve Seljebu'.format(now.year)

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -201,8 +203,8 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'leicacam.tex', u'leicacam Documentation',
u'Arve Seljebu', 'manual'),
('index', 'leicacam.tex', 'leicacam Documentation',
'Arve Seljebu', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down Expand Up @@ -231,8 +233,8 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'leicacam', u'leicacam Documentation',
[u'Arve Seljebu'], 1)
('index', 'leicacam', 'leicacam Documentation',
['Arve Seljebu'], 1)
]

# If true, show URL addresses after external links.
Expand All @@ -245,8 +247,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'leicacam', u'leicacam Documentation',
u'Arve Seljebu', 'leicacam', 'One line description of project.',
('index', 'leicacam', 'leicacam Documentation',
'Arve Seljebu', 'leicacam', 'One line description of project.',
'Miscellaneous'),
]

Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Sphinx==2.2.0
sphinx==2.2.0
sphinx-autobuild==0.7.1
sphinx_rtd_theme==0.4.3