Skip to content

Commit

Permalink
Move library documentation to /lib/
Browse files Browse the repository at this point in the history
  • Loading branch information
ghewgill committed Dec 30, 2023
1 parent ac6efed commit 784e293
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -903,7 +903,7 @@ add_test(

if (MONO)
add_custom_target(docs ALL
COMMAND ${MONO} "${CMAKE_BINARY_DIR}/external/Natural Docs/NaturalDocs.exe" -i ${CMAKE_SOURCE_DIR}/lib -o HTML gh-pages/html -p ${CMAKE_SOURCE_DIR}/lib/nd.proj -ro
COMMAND ${MONO} "${CMAKE_BINARY_DIR}/external/Natural Docs/NaturalDocs.exe" -i ${CMAKE_SOURCE_DIR}/lib -o HTML gh-pages/lib -p ${CMAKE_SOURCE_DIR}/lib/nd.proj -ro
)
add_custom_target(docs_samples ALL
COMMAND ${MONO} "${CMAKE_BINARY_DIR}/external/Natural Docs/NaturalDocs.exe" -i ${CMAKE_SOURCE_DIR}/samples -o HTML gh-pages/samples -p ${CMAKE_SOURCE_DIR}/samples/nd.proj -ro
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/library.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
= Standard Library

See link:../../../html/[Standard Library].
See link:../../../lib/[Standard Library].
Empty file added gh-pages/lib/.gitignore
Empty file.
6 changes: 3 additions & 3 deletions scripts/update_docs
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ rm -rf tmp-gh-pages/* $(ls -d tmp-gh-pages/.* | grep -v -E '/\.(\.|git)?$')

# Copy generated documentation to temporary dir
cp -r gh-pages/_site/. tmp-gh-pages/ # web site main pages
cp -r build/site/. tmp-gh-pages/docs/ # sphinx language documentation
cp -r gh-pages/html tmp-gh-pages/ # naturaldocs library
cp -r build/site/. tmp-gh-pages/docs/ # antora language documentation
cp -r gh-pages/lib tmp-gh-pages/ # naturaldocs library
cp -r gh-pages/samples tmp-gh-pages/ # naturaldocs samples

# Remove .gitignore so we can sensibly commit generated files
rm -f tmp-gh-pages/html/.gitignore tmp-gh-pages/samples/.gitignore
rm -f tmp-gh-pages/lib/.gitignore tmp-gh-pages/samples/.gitignore
cp .git/info/exclude tmp-gh-pages/.git/info/

# Add .nojekyll file because we have already done that and don't need github to do it again
Expand Down
2 changes: 1 addition & 1 deletion supplemental-ui/partials/header-content.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Library</a>
<div class="navbar-dropdown">
<a class="navbar-item" href="/html/">Reference</a>
<a class="navbar-item" href="/lib/">Reference</a>
<a class="navbar-item" href="/samples/">Samples</a>
</div>
</div>
Expand Down

0 comments on commit 784e293

Please sign in to comment.