Skip to content

Commit

Permalink
docs: 📝 created a redirect for an old studio doc
Browse files Browse the repository at this point in the history
  • Loading branch information
newgene committed Jan 31, 2022
1 parent 181d3c1 commit 6dce4ce
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ SDK repository](https://github.com/biothings/biothings.api) and run:

## Get started to build a BioThings API

We recommend to follow [this tutorial](https://docs.biothings.io/en/latest/doc/studio.html) to develop your first BioThings API in our pre-configured **BioThings Studio** development environment.
We recommend to follow [this tutorial](https://docs.biothings.io/en/latest/tutorial/studio.html) to develop your first BioThings API in our pre-configured **BioThings Studio** development environment.

## Documentation

Expand Down
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon', # support numpy and google style docstring
'sphinx_reredirects' # handle old page redirection see "redirects" setting below
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -74,6 +75,10 @@
# Ref: http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autoclass_content
autoclass_content = 'both'

redirects = {
"doc/studio": "../tutorial/studio.html"
}

# Reference Code
# ---------------------
# Previous attemps to configure biothings.hub
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ def read(fname):
# extra requirements for building docs
docs_requires = [
'sphinx>=2.4.3',
'sphinx_rtd_theme>=0.4.3'
'sphinx_rtd_theme>=1.0.0',
'sphinx_reredirects>=0.0.1'
]

setup(
Expand Down

0 comments on commit 6dce4ce

Please sign in to comment.