Skip to content

Commit

Permalink
Fix: Update documentation build script paths
Browse files Browse the repository at this point in the history
- Updated `make-doc.sh` to ensure correct paths for Sphinx documentation generation.
- Ensured `sphinx-apidoc` generates documentation from the correct source directory.
- Added `make -C doc html` to build the HTML documentation in the correct directory.
  • Loading branch information
MostlyKIGuess committed Jan 20, 2025
1 parent a6a5377 commit b05ad94
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
9 changes: 4 additions & 5 deletions ci/docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@ sudo make

# make documentation
show-green "Building documentation"
./make-doc.sh
cd doc
make html
cd ..
mkdir deploy
cp -r doc/_build/html deploy/sugar3
touch deploy/.nojekyll
# create an index.html so that users don't become confused
show-green "Writing index.html"
echo "<h1>Page Moved</h1>" > deploy/index.html
echo "<p>We have moved this page to <a href=\"https://github.com/sugarlabs/sugar-docs/blob/master/README.md\">GitHub</a>.</p>" >> deploy/index.html
echo "<p>How did you get here? Please <a href=\"https://github.com/sugarlabs/sugar-docs/issues\">report</a> any lingering links.</p>" >> deploy/index.html

show-green "Done"
echo "<p>We have moved this page to <a href=\"https://github.com/sugarlabs/sugar-docs/blob/master/README.md\">GitHub</a>.</p>" >> deploy/index.html
4 changes: 2 additions & 2 deletions make-doc.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/sh

sphinx-apidoc --force --separate --output-dir=doc src
make -C doc html
sphinx-apidoc --force --separate --output-dir=doc ../src
make -C doc html

0 comments on commit b05ad94

Please sign in to comment.