Skip to content

Commit 62130af

Browse files
authored
Fix API documentation location (#238)
1 parent f0f0268 commit 62130af

File tree

5 files changed

+6
-7
lines changed

5 files changed

+6
-7
lines changed

.github/workflows/docs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ jobs:
3737
with:
3838
node-version: 14
3939

40-
- name: Build documentation
41-
run: ./scripts/build_docs.sh
40+
- name: Build Sphinx documentation
41+
run: scripts/build_docs.sh
4242

4343
- name: Build Docusaurus website
4444
run: |

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
- Added pytest-mock to dev dependencies. ([#168](https://github.com/Rose-STL-Lab/torchTS/pull/168))
1212
- Added website descriptions for new features. ([#165](https://github.com/Rose-STL-Lab/torchTS/pull/165), [#169](https://github.com/Rose-STL-Lab/torchTS/pull/169))
1313
- Added mean interval score loss function. ([#188](https://github.com/Rose-STL-Lab/torchTS/pull/188))
14-
- Added API documentation to website. ([#206](https://github.com/Rose-STL-Lab/torchTS/pull/206), [#237](https://github.com/Rose-STL-Lab/torchTS/pull/237))
14+
- Added API documentation to website. ([#206](https://github.com/Rose-STL-Lab/torchTS/pull/206), [#237](https://github.com/Rose-STL-Lab/torchTS/pull/237), [#238](https://github.com/Rose-STL-Lab/torchTS/pull/238))
1515

1616
### Changed
1717

docs/source/_templates/theme_variables.jinja

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{%- set external_urls = {
22
'github': 'https://github.com/Rose-STL-Lab/torchTS',
3-
'home': 'https://rose-stl-lab.github.io/torchTS/docs/',
3+
'home': 'https://rose-stl-lab.github.io/torchTS/api/',
44
'get_started': ' ',
55
'blog': 'https://github.com/Rose-STL-Lab/torchTS',
66
'resources': 'https://github.com/Rose-STL-Lab/torchTS',
7-
'docs': 'https://github.com/Rose-STL-Lab/torchTS/docs',
7+
'docs': 'https://rose-stl-lab.github.io/torchTS/docs/',
88
'twitter': 'https://twitter.com/',
99
'discuss': 'https://discuss.pytorch.org',
1010
'tutorials': 'https://github.com/Rose-STL-Lab/torchTS/docs',

docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
# documentation.
8989
html_theme_options = {
9090
"pytorch_project": "tutorials",
91-
"canonical_url": "https://rose-stl-lab.github.io/torchTS/docs/",
91+
"canonical_url": "https://rose-stl-lab.github.io/torchTS/api/",
9292
"collapse_navigation": False,
9393
"display_version": True,
9494
"logo": "_static/images/torchTS_logo.png",

scripts/build_docs.sh

-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,5 @@ echo "Moving Sphinx documentation to Docusaurus"
1212
echo "-----------------------------------------"
1313

1414
SPHINX_HTML_DIR="website/static/api/"
15-
mkdir -p $SPHINX_HTML_DIR
1615
cp -R "./docs/build/html/" "./${SPHINX_HTML_DIR}"
1716
echo "Sucessfully moved Sphinx docs to ${SPHINX_HTML_DIR}"

0 commit comments

Comments
 (0)