diff options
| author | Santos Gallegos <santos_g@outlook.com> | 2019-05-04 23:33:50 -0500 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2019-07-20 19:45:22 +0800 |
| commit | a02facd0b4f9c2d2c039f0d7dc5af8354ce0201b (patch) | |
| tree | 3c85470e2fa3561baf26881c4afa370ecc6c864d | |
| parent | 6df6d41835cd331995ad012ede3f72ef2834a6c5 (diff) | |
| download | gitpython-a02facd0b4f9c2d2c039f0d7dc5af8354ce0201b.tar.gz | |
Build docs locally
Currently `make html` will output pages without styles
or different than the online documentation.
With this change the local documentation looks the same as the online
documentation.
| -rw-r--r-- | .travis.yml | 3 | ||||
| -rw-r--r-- | doc/requirements.txt | 2 | ||||
| -rw-r--r-- | doc/source/conf.py | 10 |
3 files changed, 7 insertions, 8 deletions
diff --git a/.travis.yml b/.travis.yml index 7939e161..206c133e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,7 +22,8 @@ install: - git submodule update --init --recursive - git fetch --tags - pip install -r test-requirements.txt - - pip install codecov sphinx + - pip install -r doc/requirements.txt + - pip install codecov # generate some reflog as git-python tests need it (in master) - ./init-tests-after-clone.sh diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..98e5c06a --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,2 @@ +sphinx<2.0 +sphinx_rtd_theme diff --git a/doc/source/conf.py b/doc/source/conf.py index 2df3bbb6..96cbd667 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -30,7 +30,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['.templates'] +templates_path = [] # The suffix of source filenames. source_suffix = '.rst' @@ -94,14 +94,10 @@ pygments_style = 'sphinx' # Options for HTML output # ----------------------- +html_theme = 'sphinx_rtd_theme' html_theme_options = { } -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -html_style = 'default.css' - # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". #html_title = None @@ -121,7 +117,7 @@ html_style = 'default.css' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['.static'] +html_static_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. |