diff --git a/.travis.yml b/.travis.yml index b5f32beac1..b15082b5a0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -77,7 +77,7 @@ script: if [[ -z ${TRAVIS_TAG} ]]; then echo "Not a tagged build." else - doctr deploy doc --build-tags + doctr deploy . --build-tags fi fi diff --git a/README.md b/README.md index 1ce1a7c186..f4b4cc6451 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ python setup.py install ## Documentation -[Stable Documentation](https://bashtage.github.io/linearmodels/doc) is +[Stable Documentation](https://bashtage.github.io/linearmodels/) is built on every tagged version using [doctr](https://github.com/drdoctr/doctr). [Development Documentation](https://bashtage.github.io/linearmodels/devel) diff --git a/README.rst b/README.rst index 5d9103b158..cfed328252 100644 --- a/README.rst +++ b/README.rst @@ -105,10 +105,10 @@ The master branch can be installed by cloning the repo and running setup Documentation ------------- -`Stable Documentation `__ +`Stable Documentation `__ is built on every tagged version using `doctr `__. `Development -Documentation `__ is +Documentation `__ is automatically built on every successful build of master. Plan and status diff --git a/doc/source/conf.py b/doc/source/conf.py index e5c0dd448b..e58db2f1eb 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -130,8 +130,8 @@ # documentation. # Guzzle theme options (see theme.conf for more information) html_theme_options = { - # Set the name of the project to appear in the sidebar - "project_nav_name": project + u" " + version, + # Set the name of the project to appear in the sidebar + "project_nav_name": project + u" " + version, } # Add any paths that contain custom static files (such as style sheets) here, @@ -139,6 +139,9 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +html_sidebars = { + '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html'] +} # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. @@ -216,4 +219,4 @@ panel_data = pd.DataFrame(np.random.randn(1000,5), index=mi, columns=['y','x1','x2','x3','x4']) y = panel_data.y x = panel_data.x1 -""" \ No newline at end of file +""" diff --git a/doc/source/index.rst b/doc/source/index.rst index 5d8e694360..d0cb11ca8f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,8 +3,8 @@ Linear Model Estimation .. note:: - `Stable documentation `_ for the latest release - is located at `doc `_. + `Stable documentation `_ for the latest release + is located at `doc `_. Documentation for `recent developments `_ is located at `devel `_.