Skip to content

Commit

Permalink
DOC: Move location of stable docs
Browse files Browse the repository at this point in the history
Move stable docs to root
  • Loading branch information
bashtage committed Mar 15, 2018
1 parent 0a77400 commit 0467855
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,10 @@ The master branch can be installed by cloning the repo and running setup
Documentation
-------------

`Stable Documentation <https://bashtage.github.io/linearmodels/doc>`__
`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>`__ is
Documentation <https://bashtage.github.io/linearmodels/devel/>`__ is
automatically built on every successful build of master.

Plan and status
Expand Down
9 changes: 6 additions & 3 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,15 +130,18 @@
# 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,
# 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_sidebars = {
'**': ['logo-text.html', 'globaltoc.html', 'searchbox.html']
}
# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
Expand Down Expand Up @@ -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
"""
"""
4 changes: 2 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Linear Model Estimation

.. note::

`Stable documentation <https://bashtage.github.io/linearmodels/doc/>`_ for the latest release
is located at `doc <https://bashtage.github.io/linearmodels/doc/>`_.
`Stable documentation <https://bashtage.github.io/linearmodels/>`_ for the latest release
is located at `doc <https://bashtage.github.io/linearmodels/>`_.
Documentation for `recent developments <https://bashtage.github.io/linearmodels/devel/>`_
is located at `devel <https://bashtage.github.io/linearmodels/devel/>`_.

Expand Down

0 comments on commit 0467855

Please sign in to comment.