Repository navigation
Commit a02facd
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.1 parent 6df6d41 commit a02facd
3 files changed
Lines changed: 7 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -22,7 +22,8 @@ install: | |||
| 22 | 22 | - git submodule update --init --recursive | |
| 23 | 23 | - git fetch --tags | |
| 24 | 24 | - pip install -r test-requirements.txt | |
| 25 | - - pip install codecov sphinx | ||
| 25 | + - pip install -r doc/requirements.txt | ||
| 26 | + - pip install codecov | ||
| 26 | 27 | ||
| 27 | 28 | # generate some reflog as git-python tests need it (in master) | |
| 28 | 29 | - ./init-tests-after-clone.sh | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,2 @@ | |||
| 1 | + sphinx<2.0 | ||
| 2 | + sphinx_rtd_theme | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -30,7 +30,7 @@ | |||
| 30 | 30 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] | |
| 31 | 31 | ||
| 32 | 32 | # Add any paths that contain templates here, relative to this directory. | |
| 33 | - templates_path = ['.templates'] | ||
| 33 | + templates_path = [] | ||
| 34 | 34 | ||
| 35 | 35 | # The suffix of source filenames. | |
| 36 | 36 | source_suffix = '.rst' | |
@@ -94,14 +94,10 @@ | |||
| 94 | 94 | # Options for HTML output | |
| 95 | 95 | # ----------------------- | |
| 96 | 96 | ||
| 97 | + html_theme = 'sphinx_rtd_theme' | ||
| 97 | 98 | html_theme_options = { | |
| 98 | 99 | } | |
| 99 | 100 | ||
| 100 | - # The style sheet to use for HTML and HTML Help pages. A file of that name | ||
| 101 | - # must exist either in Sphinx' static/ path, or in one of the custom paths | ||
| 102 | - # given in html_static_path. | ||
| 103 | - html_style = 'default.css' | ||
| 104 | - | ||
| 105 | 101 | # The name for this set of Sphinx documents. If None, it defaults to | |
| 106 | 102 | # "<project> v<release> documentation". | |
| 107 | 103 | #html_title = None | |
@@ -121,7 +117,7 @@ | |||
| 121 | 117 | # Add any paths that contain custom static files (such as style sheets) here, | |
| 122 | 118 | # relative to this directory. They are copied after the builtin static files, | |
| 123 | 119 | # so a file named "default.css" will overwrite the builtin "default.css". | |
| 124 | - html_static_path = ['.static'] | ||
| 120 | + html_static_path = [] | ||
| 125 | 121 | ||
| 126 | 122 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |
| 127 | 123 | # using the given strftime format. | |
0 commit comments