diff --git a/.github/workflows/generate-github-pages.yml b/.github/workflows/deploy-documentation-github-pages.yml similarity index 57% rename from .github/workflows/generate-github-pages.yml rename to .github/workflows/deploy-documentation-github-pages.yml index 48bccc9bc..6ab476bd6 100644 --- a/.github/workflows/generate-github-pages.yml +++ b/.github/workflows/deploy-documentation-github-pages.yml @@ -1,4 +1,4 @@ -name: Generate GitHub Pages +name: Deploy Documentation GitHub Pages on: push: @@ -6,19 +6,19 @@ on: - feature/new-docs jobs: - generate-github-pages: + deploy-documentation-github-pages: runs-on: ubuntu-latest container: gpuci/cccl:cuda11.3.1-devel-ubuntu20.04-gcc9 steps: - name: Checkout repository uses: actions/checkout@v2 - name: Generate documentation markdown - run: ./docs/generate_markdown.bash + run: ./docs/generate_markdown.bash --clean - name: Deploy generated documentation markdown to gh-pages branch uses: peaceiris/actions-gh-pages@v3 - if: github.ref == 'refs/heads/feature/new-docs' + if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/feature/new-docs' with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs + publish_dir: ./build_docs/github_pages enable_jekyll: true - commit_message: "Deploy Docs: ${{ github.event.head_commit.message }}" + commit_message: "Deploy Documentation: ${{ github.event.head_commit.message }}" diff --git a/.gitignore b/.gitignore index 6011e534a..2474bed01 100644 --- a/.gitignore +++ b/.gitignore @@ -1,11 +1 @@ discrete_voronoi.pgm -docs/html/ -docs/api/ -docs/overview.md -docs/contributing/code_of_conduct.md -docs/releases/changelog.md -docs/Gemfile.lock -docs/_site -docs/.bundle -docs/.sass-cache -docs/.jekyll-metadata diff --git a/docs/doxybook_config.json b/docs/doxybook/config.json similarity index 97% rename from docs/doxybook_config.json rename to docs/doxybook/config.json index 21d3ee39d..56b7a238b 100644 --- a/docs/doxybook_config.json +++ b/docs/doxybook/config.json @@ -1,5 +1,5 @@ { - "baseUrl": "/thrust/api/", + "baseUrl": "{{ site.baseurl }}/api/", "copyImages": true, "fileExt": "md", "filesFilter": [], diff --git a/docs/doxybook_templates/class_members.tmpl b/docs/doxybook/templates/class_members.tmpl similarity index 100% rename from docs/doxybook_templates/class_members.tmpl rename to docs/doxybook/templates/class_members.tmpl diff --git a/docs/doxybook_templates/class_members_details.tmpl b/docs/doxybook/templates/class_members_details.tmpl similarity index 100% rename from docs/doxybook_templates/class_members_details.tmpl rename to docs/doxybook/templates/class_members_details.tmpl diff --git a/docs/doxybook_templates/details.tmpl b/docs/doxybook/templates/details.tmpl similarity index 100% rename from docs/doxybook_templates/details.tmpl rename to docs/doxybook/templates/details.tmpl diff --git a/docs/doxybook_templates/frontmatter.tmpl b/docs/doxybook/templates/frontmatter.tmpl similarity index 100% rename from docs/doxybook_templates/frontmatter.tmpl rename to docs/doxybook/templates/frontmatter.tmpl diff --git a/docs/doxybook_templates/index.tmpl b/docs/doxybook/templates/index.tmpl similarity index 100% rename from docs/doxybook_templates/index.tmpl rename to docs/doxybook/templates/index.tmpl diff --git a/docs/doxybook_templates/index_classes.tmpl b/docs/doxybook/templates/index_classes.tmpl similarity index 100% rename from docs/doxybook_templates/index_classes.tmpl rename to docs/doxybook/templates/index_classes.tmpl diff --git a/docs/doxybook_templates/index_examples.tmpl b/docs/doxybook/templates/index_examples.tmpl similarity index 100% rename from docs/doxybook_templates/index_examples.tmpl rename to docs/doxybook/templates/index_examples.tmpl diff --git a/docs/doxybook_templates/index_files.tmpl b/docs/doxybook/templates/index_files.tmpl similarity index 100% rename from docs/doxybook_templates/index_files.tmpl rename to docs/doxybook/templates/index_files.tmpl diff --git a/docs/doxybook_templates/index_groups.tmpl b/docs/doxybook/templates/index_groups.tmpl similarity index 100% rename from docs/doxybook_templates/index_groups.tmpl rename to docs/doxybook/templates/index_groups.tmpl diff --git a/docs/doxybook_templates/index_namespaces.tmpl b/docs/doxybook/templates/index_namespaces.tmpl similarity index 100% rename from docs/doxybook_templates/index_namespaces.tmpl rename to docs/doxybook/templates/index_namespaces.tmpl diff --git a/docs/doxybook_templates/index_pages.tmpl b/docs/doxybook/templates/index_pages.tmpl similarity index 100% rename from docs/doxybook_templates/index_pages.tmpl rename to docs/doxybook/templates/index_pages.tmpl diff --git a/docs/doxybook_templates/kind_class.tmpl b/docs/doxybook/templates/kind_class.tmpl similarity index 100% rename from docs/doxybook_templates/kind_class.tmpl rename to docs/doxybook/templates/kind_class.tmpl diff --git a/docs/doxybook_templates/kind_example.tmpl b/docs/doxybook/templates/kind_example.tmpl similarity index 100% rename from docs/doxybook_templates/kind_example.tmpl rename to docs/doxybook/templates/kind_example.tmpl diff --git a/docs/doxybook_templates/kind_file.tmpl b/docs/doxybook/templates/kind_file.tmpl similarity index 100% rename from docs/doxybook_templates/kind_file.tmpl rename to docs/doxybook/templates/kind_file.tmpl diff --git a/docs/doxybook_templates/kind_group.tmpl b/docs/doxybook/templates/kind_group.tmpl similarity index 100% rename from docs/doxybook_templates/kind_group.tmpl rename to docs/doxybook/templates/kind_group.tmpl diff --git a/docs/doxybook_templates/kind_nonclass.tmpl b/docs/doxybook/templates/kind_nonclass.tmpl similarity index 100% rename from docs/doxybook_templates/kind_nonclass.tmpl rename to docs/doxybook/templates/kind_nonclass.tmpl diff --git a/docs/doxybook_templates/kind_page.tmpl b/docs/doxybook/templates/kind_page.tmpl similarity index 100% rename from docs/doxybook_templates/kind_page.tmpl rename to docs/doxybook/templates/kind_page.tmpl diff --git a/docs/doxybook_templates/member_details.tmpl b/docs/doxybook/templates/member_details.tmpl similarity index 100% rename from docs/doxybook_templates/member_details.tmpl rename to docs/doxybook/templates/member_details.tmpl diff --git a/docs/doxybook_templates/name.tmpl b/docs/doxybook/templates/name.tmpl similarity index 100% rename from docs/doxybook_templates/name.tmpl rename to docs/doxybook/templates/name.tmpl diff --git a/docs/doxybook_templates/name_qualified.tmpl b/docs/doxybook/templates/name_qualified.tmpl similarity index 100% rename from docs/doxybook_templates/name_qualified.tmpl rename to docs/doxybook/templates/name_qualified.tmpl diff --git a/docs/doxybook_templates/name_unqualified.tmpl b/docs/doxybook/templates/name_unqualified.tmpl similarity index 100% rename from docs/doxybook_templates/name_unqualified.tmpl rename to docs/doxybook/templates/name_unqualified.tmpl diff --git a/docs/doxybook_templates/namespace_members.tmpl b/docs/doxybook/templates/namespace_members.tmpl similarity index 100% rename from docs/doxybook_templates/namespace_members.tmpl rename to docs/doxybook/templates/namespace_members.tmpl diff --git a/docs/doxybook_templates/nonclass_members.tmpl b/docs/doxybook/templates/nonclass_members.tmpl similarity index 100% rename from docs/doxybook_templates/nonclass_members.tmpl rename to docs/doxybook/templates/nonclass_members.tmpl diff --git a/docs/doxybook_templates/nonclass_members_details.tmpl b/docs/doxybook/templates/nonclass_members_details.tmpl similarity index 100% rename from docs/doxybook_templates/nonclass_members_details.tmpl rename to docs/doxybook/templates/nonclass_members_details.tmpl diff --git a/docs/doxybook_templates/synopsis_brief.tmpl b/docs/doxybook/templates/synopsis_brief.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_brief.tmpl rename to docs/doxybook/templates/synopsis_brief.tmpl diff --git a/docs/doxybook_templates/synopsis_class.tmpl b/docs/doxybook/templates/synopsis_class.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_class.tmpl rename to docs/doxybook/templates/synopsis_class.tmpl diff --git a/docs/doxybook_templates/synopsis_friend_class.tmpl b/docs/doxybook/templates/synopsis_friend_class.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_friend_class.tmpl rename to docs/doxybook/templates/synopsis_friend_class.tmpl diff --git a/docs/doxybook_templates/synopsis_friend_function.tmpl b/docs/doxybook/templates/synopsis_friend_function.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_friend_function.tmpl rename to docs/doxybook/templates/synopsis_friend_function.tmpl diff --git a/docs/doxybook_templates/synopsis_function.tmpl b/docs/doxybook/templates/synopsis_function.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_function.tmpl rename to docs/doxybook/templates/synopsis_function.tmpl diff --git a/docs/doxybook_templates/synopsis_function_parameters.tmpl b/docs/doxybook/templates/synopsis_function_parameters.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_function_parameters.tmpl rename to docs/doxybook/templates/synopsis_function_parameters.tmpl diff --git a/docs/doxybook_templates/synopsis_function_trailing_specifiers.tmpl b/docs/doxybook/templates/synopsis_function_trailing_specifiers.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_function_trailing_specifiers.tmpl rename to docs/doxybook/templates/synopsis_function_trailing_specifiers.tmpl diff --git a/docs/doxybook_templates/synopsis_function_type_and_leading_specifiers.tmpl b/docs/doxybook/templates/synopsis_function_type_and_leading_specifiers.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_function_type_and_leading_specifiers.tmpl rename to docs/doxybook/templates/synopsis_function_type_and_leading_specifiers.tmpl diff --git a/docs/doxybook_templates/synopsis_indent.tmpl b/docs/doxybook/templates/synopsis_indent.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_indent.tmpl rename to docs/doxybook/templates/synopsis_indent.tmpl diff --git a/docs/doxybook_templates/synopsis_inherited_from.tmpl b/docs/doxybook/templates/synopsis_inherited_from.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_inherited_from.tmpl rename to docs/doxybook/templates/synopsis_inherited_from.tmpl diff --git a/docs/doxybook_templates/synopsis_inherited_from_comment.tmpl b/docs/doxybook/templates/synopsis_inherited_from_comment.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_inherited_from_comment.tmpl rename to docs/doxybook/templates/synopsis_inherited_from_comment.tmpl diff --git a/docs/doxybook_templates/synopsis_initializer.tmpl b/docs/doxybook/templates/synopsis_initializer.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_initializer.tmpl rename to docs/doxybook/templates/synopsis_initializer.tmpl diff --git a/docs/doxybook_templates/synopsis_initializer_abbreviated.tmpl b/docs/doxybook/templates/synopsis_initializer_abbreviated.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_initializer_abbreviated.tmpl rename to docs/doxybook/templates/synopsis_initializer_abbreviated.tmpl diff --git a/docs/doxybook_templates/synopsis_kind.tmpl b/docs/doxybook/templates/synopsis_kind.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_kind.tmpl rename to docs/doxybook/templates/synopsis_kind.tmpl diff --git a/docs/doxybook_templates/synopsis_kind_abbreviated.tmpl b/docs/doxybook/templates/synopsis_kind_abbreviated.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_kind_abbreviated.tmpl rename to docs/doxybook/templates/synopsis_kind_abbreviated.tmpl diff --git a/docs/doxybook_templates/synopsis_leading_line_break.tmpl b/docs/doxybook/templates/synopsis_leading_line_break.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_leading_line_break.tmpl rename to docs/doxybook/templates/synopsis_leading_line_break.tmpl diff --git a/docs/doxybook_templates/synopsis_macro.tmpl b/docs/doxybook/templates/synopsis_macro.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_macro.tmpl rename to docs/doxybook/templates/synopsis_macro.tmpl diff --git a/docs/doxybook_templates/synopsis_member_namespace_abbreviated.tmpl b/docs/doxybook/templates/synopsis_member_namespace_abbreviated.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_member_namespace_abbreviated.tmpl rename to docs/doxybook/templates/synopsis_member_namespace_abbreviated.tmpl diff --git a/docs/doxybook_templates/synopsis_namespace_abbreviated.tmpl b/docs/doxybook/templates/synopsis_namespace_abbreviated.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_namespace_abbreviated.tmpl rename to docs/doxybook/templates/synopsis_namespace_abbreviated.tmpl diff --git a/docs/doxybook_templates/synopsis_template_parameters.tmpl b/docs/doxybook/templates/synopsis_template_parameters.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_template_parameters.tmpl rename to docs/doxybook/templates/synopsis_template_parameters.tmpl diff --git a/docs/doxybook_templates/synopsis_type.tmpl b/docs/doxybook/templates/synopsis_type.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_type.tmpl rename to docs/doxybook/templates/synopsis_type.tmpl diff --git a/docs/doxybook_templates/synopsis_type_and_leading_specifiers.tmpl b/docs/doxybook/templates/synopsis_type_and_leading_specifiers.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_type_and_leading_specifiers.tmpl rename to docs/doxybook/templates/synopsis_type_and_leading_specifiers.tmpl diff --git a/docs/doxybook_templates/synopsis_variable.tmpl b/docs/doxybook/templates/synopsis_variable.tmpl similarity index 100% rename from docs/doxybook_templates/synopsis_variable.tmpl rename to docs/doxybook/templates/synopsis_variable.tmpl diff --git a/docs/doxybook_templates/table_header_brief.tmpl b/docs/doxybook/templates/table_header_brief.tmpl similarity index 100% rename from docs/doxybook_templates/table_header_brief.tmpl rename to docs/doxybook/templates/table_header_brief.tmpl diff --git a/docs/doxybook_templates/table_header_enum.tmpl b/docs/doxybook/templates/table_header_enum.tmpl similarity index 100% rename from docs/doxybook_templates/table_header_enum.tmpl rename to docs/doxybook/templates/table_header_enum.tmpl diff --git a/docs/doxybook_templates/table_row_brief.tmpl b/docs/doxybook/templates/table_row_brief.tmpl similarity index 100% rename from docs/doxybook_templates/table_row_brief.tmpl rename to docs/doxybook/templates/table_row_brief.tmpl diff --git a/docs/doxybook_templates/table_row_enum.tmpl b/docs/doxybook/templates/table_row_enum.tmpl similarity index 100% rename from docs/doxybook_templates/table_row_enum.tmpl rename to docs/doxybook/templates/table_row_enum.tmpl diff --git a/docs/doxybook_templates/title_kind.tmpl b/docs/doxybook/templates/title_kind.tmpl similarity index 100% rename from docs/doxybook_templates/title_kind.tmpl rename to docs/doxybook/templates/title_kind.tmpl diff --git a/docs/doxybook_templates/title_leading.tmpl b/docs/doxybook/templates/title_leading.tmpl similarity index 100% rename from docs/doxybook_templates/title_leading.tmpl rename to docs/doxybook/templates/title_leading.tmpl diff --git a/docs/doxybook_templates/title_member.tmpl b/docs/doxybook/templates/title_member.tmpl similarity index 100% rename from docs/doxybook_templates/title_member.tmpl rename to docs/doxybook/templates/title_member.tmpl diff --git a/docs/doxybook_templates/title_nonmember.tmpl b/docs/doxybook/templates/title_nonmember.tmpl similarity index 100% rename from docs/doxybook_templates/title_nonmember.tmpl rename to docs/doxybook/templates/title_nonmember.tmpl diff --git a/docs/doxybook_templates/title_trailing.tmpl b/docs/doxybook/templates/title_trailing.tmpl similarity index 100% rename from docs/doxybook_templates/title_trailing.tmpl rename to docs/doxybook/templates/title_trailing.tmpl diff --git a/docs/doxygen_config.dox b/docs/doxygen/config.dox similarity index 99% rename from docs/doxygen_config.dox rename to docs/doxygen/config.dox index 362094c06..7e06e3545 100644 --- a/docs/doxygen_config.dox +++ b/docs/doxygen/config.dox @@ -1149,7 +1149,7 @@ GENERATE_HTML = NO # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_OUTPUT = build_doxygen_html +HTML_OUTPUT = build_docs/doxygen/html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). @@ -2058,7 +2058,7 @@ GENERATE_XML = YES # The default directory is: xml. # This tag requires that the tag GENERATE_XML is set to YES. -XML_OUTPUT = build_doxygen_xml +XML_OUTPUT = build_docs/doxygen/xml # If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to diff --git a/docs/generate_markdown.bash b/docs/generate_markdown.bash index 76448c404..3b711db10 100755 --- a/docs/generate_markdown.bash +++ b/docs/generate_markdown.bash @@ -27,14 +27,15 @@ function usage { echo "-h, -help, --help" echo " Print this message." echo - echo "-l, --local" - echo " Generate markdown suitable for a locally run Jekyll server instead of " - echo " the production GitHub pages environment." + echo "-c, --clean" + echo " Delete the all existing build artifacts before generating the " + echo " markdown." exit -3 } LOCAL=0 +CLEAN=0 while test ${#} != 0 do @@ -42,44 +43,49 @@ do -h) ;& -help) ;& --help) usage ;; - -l) ;& - --local) LOCAL=1 ;; + -c) ;& + --clean) CLEAN=1 ;; esac shift done SCRIPT_PATH=$(cd $(dirname ${0}); pwd -P) -cd ${SCRIPT_PATH}/.. - -rm -rf build_doxygen_xml -rm -rf docs/api -rm -f docs/overview.md -rm -f docs/contributing/code_of_conduct.md -rm -f docs/releases/changelog.md - -mkdir -p docs/api -mkdir -p docs/contributing -mkdir -p docs/releases - -# We need to copy these files into the `docs/` root because Jekyll doesn't let -# you include content outside of its root. -cp README.md docs/overview.md -cp CODE_OF_CONDUCT.md docs/contributing/code_of_conduct.md -cp CHANGELOG.md docs/releases/changelog.md - -doxygen docs/doxygen_config.dox - -# When we're deploying to production on GitHub Pages, the root is -# `nvidia.github.io/thrust`. When we're building locally, the root is normally -# just `localhost`. -if [[ "${LOCAL}" == 1 ]]; then - BASE_URL='{"baseUrl": "/api/"}' -else - BASE_URL='{"baseUrl": "/thrust/api/"}' +REPO_PATH=${SCRIPT_PATH}/.. + +BUILD_DOCS_PATH=build_docs +BUILD_DOXYGEN_PATH=${BUILD_DOCS_PATH}/doxygen +BUILD_GITHUB_PAGES_PATH=${BUILD_DOCS_PATH}/github_pages + +cd ${REPO_PATH} + +if [[ "${CLEAN}" == 1 ]]; then + rm -rf ${BUILD_DOXYGEN_PATH} + rm -rf ${BUILD_GITHUB_PAGES_PATH} fi -doxybook2 -d -i build_doxygen_xml -o docs/api -c docs/doxybook_config.json --config-data "${BASE_URL}" -t docs/doxybook_templates +mkdir -p ${BUILD_DOXYGEN_PATH}/xml +mkdir -p ${BUILD_GITHUB_PAGES_PATH} +mkdir -p ${BUILD_GITHUB_PAGES_PATH}/api +mkdir -p ${BUILD_GITHUB_PAGES_PATH}/contributing +mkdir -p ${BUILD_GITHUB_PAGES_PATH}/releases + +# Copy all the documentation sources and Jekyll configuration into +# `{BUILD_GITHUB_PAGES_PATH}`. +cp -ur docs/github_pages/* ${BUILD_GITHUB_PAGES_PATH}/ +cp README.md ${BUILD_GITHUB_PAGES_PATH}/overview.md +cp CODE_OF_CONDUCT.md ${BUILD_GITHUB_PAGES_PATH}/contributing/code_of_conduct.md +cp CHANGELOG.md ${BUILD_GITHUB_PAGES_PATH}/releases/changelog.md + +doxygen docs/doxygen/config.dox + +# `--debug-templates` will cause JSON output to be generated, which is useful +# for debugging. +doxybook2 --config docs/doxybook/config.json \ + --templates docs/doxybook/templates \ + --debug-templates \ + --input ${BUILD_DOXYGEN_PATH}/xml \ + --output ${BUILD_GITHUB_PAGES_PATH}/api # Doxygen and Doxybook don't give us a way to disable all the things we'd like, # so it's important to purge Doxybook Markdown output that we don't need: @@ -87,14 +93,14 @@ doxybook2 -d -i build_doxygen_xml -o docs/api -c docs/doxybook_config.json --con # on stuff we don't need. # 1) We don't want content that we don't plan to use to either show up on the # site index or appear in search results. -rm -rf docs/api/files -rm -rf docs/api/index_files.md -rm -rf docs/api/pages -rm -rf docs/api/index_pages.md -rm -rf docs/api/examples -rm -rf docs/api/index_examples.md -rm -rf docs/api/images -rm -rf docs/api/index_namespaces.md -rm -rf docs/api/index_groups.md -rm -rf docs/api/index_classes.md +rm -rf ${BUILD_GITHUB_PAGES_PATH}/api/files +rm -rf ${BUILD_GITHUB_PAGES_PATH}/api/index_files.md +rm -rf ${BUILD_GITHUB_PAGES_PATH}/api/pages +rm -rf ${BUILD_GITHUB_PAGES_PATH}/api/index_pages.md +rm -rf ${BUILD_GITHUB_PAGES_PATH}/api/examples +rm -rf ${BUILD_GITHUB_PAGES_PATH}/api/index_examples.md +rm -rf ${BUILD_GITHUB_PAGES_PATH}/api/images +rm -rf ${BUILD_GITHUB_PAGES_PATH}/api/index_namespaces.md +rm -rf ${BUILD_GITHUB_PAGES_PATH}/api/index_groups.md +rm -rf ${BUILD_GITHUB_PAGES_PATH}/api/index_classes.md diff --git a/docs/Gemfile b/docs/github_pages/Gemfile similarity index 100% rename from docs/Gemfile rename to docs/github_pages/Gemfile diff --git a/docs/_config.yml b/docs/github_pages/_config.yml similarity index 100% rename from docs/_config.yml rename to docs/github_pages/_config.yml diff --git a/docs/_sass/color_schemes/nvidia.scss b/docs/github_pages/_sass/color_schemes/nvidia.scss similarity index 100% rename from docs/_sass/color_schemes/nvidia.scss rename to docs/github_pages/_sass/color_schemes/nvidia.scss diff --git a/docs/api.md b/docs/github_pages/api.md similarity index 100% rename from docs/api.md rename to docs/github_pages/api.md diff --git a/docs/assets/images/nvidia_logo.png b/docs/github_pages/assets/images/nvidia_logo.png similarity index 100% rename from docs/assets/images/nvidia_logo.png rename to docs/github_pages/assets/images/nvidia_logo.png diff --git a/docs/contributing.md b/docs/github_pages/contributing.md similarity index 100% rename from docs/contributing.md rename to docs/github_pages/contributing.md diff --git a/docs/contributing/release_process.md b/docs/github_pages/contributing/release_process.md similarity index 100% rename from docs/contributing/release_process.md rename to docs/github_pages/contributing/release_process.md diff --git a/docs/contributing/submitting_a_pr.md b/docs/github_pages/contributing/submitting_a_pr.md similarity index 100% rename from docs/contributing/submitting_a_pr.md rename to docs/github_pages/contributing/submitting_a_pr.md diff --git a/docs/favicon.ico b/docs/github_pages/favicon.ico similarity index 100% rename from docs/favicon.ico rename to docs/github_pages/favicon.ico diff --git a/docs/releases.md b/docs/github_pages/releases.md similarity index 100% rename from docs/releases.md rename to docs/github_pages/releases.md diff --git a/docs/releases/versioning.md b/docs/github_pages/releases/versioning.md similarity index 100% rename from docs/releases/versioning.md rename to docs/github_pages/releases/versioning.md diff --git a/docs/setup.md b/docs/github_pages/setup.md similarity index 100% rename from docs/setup.md rename to docs/github_pages/setup.md diff --git a/docs/setup/cmake_options.md b/docs/github_pages/setup/cmake_options.md similarity index 100% rename from docs/setup/cmake_options.md rename to docs/github_pages/setup/cmake_options.md diff --git a/docs/setup/requirements.md b/docs/github_pages/setup/requirements.md similarity index 100% rename from docs/setup/requirements.md rename to docs/github_pages/setup/requirements.md diff --git a/docs/serve_docs_locally.bash b/docs/serve_docs_locally.bash index 5695e664f..f438795e4 100755 --- a/docs/serve_docs_locally.bash +++ b/docs/serve_docs_locally.bash @@ -18,7 +18,18 @@ SCRIPT_PATH=$(cd $(dirname ${0}); pwd -P) -cd ${SCRIPT_PATH}/.. +REPO_PATH=${SCRIPT_PATH}/.. + +BUILD_DOCS_PATH=build_docs +BUILD_GITHUB_PAGES_PATH=${BUILD_DOCS_PATH}/github_pages + +cd ${REPO_PATH}/${BUILD_GITHUB_PAGES_PATH} bundle install -bundle exec jekyll serve --incremental --profile --verbose +bundle exec jekyll serve \ + --verbose \ + --incremental \ + --profile \ + --baseurl "/thrust" \ + ${@} +