Skip to content

Commit f0f0268

Browse files
authored
Fix API documentation link (#237)
1 parent 906c10a commit f0f0268

File tree

4 files changed

+16
-18
lines changed

4 files changed

+16
-18
lines changed

.github/labeler.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ dependencies:
77

88
documentation:
99
- docs/**
10+
- scripts/**
1011
- website/**
1112

1213
examples:

.github/workflows/docs.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@ on:
66
- main
77
paths:
88
- 'docs/**'
9+
- 'scripts/**'
910
- 'torchts/**'
10-
- 'poetry.lock'
1111
- 'website/**'
12+
- 'poetry.lock'
1213
pull_request:
1314
branches:
1415
- main
1516
paths:
1617
- 'docs/**'
18+
- 'scripts/**'
1719
- 'torchts/**'
18-
- 'poetry.lock'
1920
- 'website/**'
21+
- 'poetry.lock'
2022

2123
jobs:
2224
build:

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
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))
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))
1515

1616
### Changed
1717

scripts/build_docs.sh

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,17 @@
11
#!/bin/bash
22
# run this script from the project root using `./scripts/build_docs.sh`
33

4-
echo "-----------------------------------"
5-
echo "Generating API reference via Sphinx"
6-
echo "-----------------------------------"
7-
cd docs || exit
8-
make html
9-
cd .. || exit
4+
echo "----------------------------------------"
5+
echo "Generating API documentation with Sphinx"
6+
echo "----------------------------------------"
107

8+
poetry run make -C docs html
119

12-
# run script to parse html generated by sphinx
13-
echo "--------------------------------------------"
14-
echo "Parsing Sphinx docs and moving to Docusaurus"
15-
echo "--------------------------------------------"
16-
mkdir -p "website/static/api/"
10+
echo "-----------------------------------------"
11+
echo "Moving Sphinx documentation to Docusaurus"
12+
echo "-----------------------------------------"
1713

18-
cwd=$(pwd)
1914
SPHINX_HTML_DIR="website/static/api/"
20-
cp -R "${cwd}/docs/build/html/" "${cwd}/${SPHINX_HTML_DIR}"
21-
echo "Parsed Sucessfully"
22-
echo "Moved location: ${SPHINX_HTML_DIR}"
15+
mkdir -p $SPHINX_HTML_DIR
16+
cp -R "./docs/build/html/" "./${SPHINX_HTML_DIR}"
17+
echo "Sucessfully moved Sphinx docs to ${SPHINX_HTML_DIR}"

0 commit comments

Comments
 (0)