Rename doxygen and sphinx folders according to other repository struc…

…tures
ROCm · Dec 4, 2023 · 058d3df · 058d3df
1 parent 852714d
commit 058d3df
Show file tree

Hide file tree

Showing 10 changed files with 8 additions and 8 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,7 +6,7 @@
 version: 2
 updates:
   - package-ecosystem: "pip" # See documentation for possible values
-    directory: "/docs/.sphinx" # Location of package manifests
+    directory: "/docs/sphinx" # Location of package manifests
     open-pull-requests-limit: 10
     schedule:
       interval: "daily"

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -10,7 +10,7 @@ formats: [htmlzip]
 
 python:
    install:
-   - requirements: docs/.sphinx/requirements.txt
+   - requirements: docs/sphinx/requirements.txt
 
 build:
    os: ubuntu-20.04

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,11 +10,11 @@ Documentation for rocFFT is available at
 * CMake support for documentation.
 
 ### Changes
-
 * Multi-device FFTs now allow batch greater than 1
 * Multi-device, real-complex FFTs are now supported
 * rocFFT now statically links libstdc++ when only `std::experimental::filesystem` is available (to guard
   against ABI incompatibilities with newer libstdc++ libraries that include `std::filesystem`)
+* Rename `docs/.doxygen` and `docs/.sphinx` folders to `docs/doxygen` and `docs/sphinx`, respectively.
 
 ## rocFFT 1.0.25 for ROCm 6.0.0 (unreleased)
 

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ To build our documentation locally, use the following code:
 ```Bash
 cd docs
 
-pip3 install -r .sphinx/requirements.txt
+pip3 install -r sphinx/requirements.txt
 
 python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
 ```

diff --git a/cmake/Dependencies.cmake b/cmake/Dependencies.cmake
@@ -86,12 +86,12 @@ if(BUILD_DOCS)
       COMMAND_ERROR_IS_FATAL ANY
     )
 
-    list(APPEND CMAKE_CONFIGURE_DEPENDS "${PROJECT_SOURCE_DIR}/docs/.sphinx/requirements.in")
+    list(APPEND CMAKE_CONFIGURE_DEPENDS "${PROJECT_SOURCE_DIR}/docs/sphinx/requirements.in")
     file(MAKE_DIRECTORY "$ENV{VIRTUAL_ENV}/usr/share/${PROJECT_NAME}")
-    if("${PROJECT_SOURCE_DIR}/docs/.sphinx/requirements.in" IS_NEWER_THAN "$ENV{VIRTUAL_ENV}/usr/share/${PROJECT_NAME}/requirements.txt")
+    if("${PROJECT_SOURCE_DIR}/docs/sphinx/requirements.in" IS_NEWER_THAN "$ENV{VIRTUAL_ENV}/usr/share/${PROJECT_NAME}/requirements.txt")
       execute_process(
         COMMAND "${Python_EXECUTABLE}" -m piptools compile
-          "${PROJECT_SOURCE_DIR}/docs/.sphinx/requirements.in"
+          "${PROJECT_SOURCE_DIR}/docs/sphinx/requirements.in"
           --output-file
           "$ENV{VIRTUAL_ENV}/usr/share/${PROJECT_NAME}/requirements.txt"
         OUTPUT_QUIET

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -23,7 +23,7 @@
 include(ROCMSphinxDoc)
 
 file(COPY
-  "${CMAKE_CURRENT_SOURCE_DIR}/.doxygen/Doxyfile"
+  "${CMAKE_CURRENT_SOURCE_DIR}/doxygen/Doxyfile"
   DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
 
 rocm_add_sphinx_doc(

diff --git a/docs/.doxygen/Doxyfile → docs/doxygen/Doxyfile b/docs/.doxygen/Doxyfile → docs/doxygen/Doxyfile
diff --git a/docs/.sphinx/_toc.yml.in → docs/sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in → docs/sphinx/_toc.yml.in
diff --git a/docs/.sphinx/requirements.in → docs/sphinx/requirements.in b/docs/.sphinx/requirements.in → docs/sphinx/requirements.in
diff --git a/docs/.sphinx/requirements.txt → docs/sphinx/requirements.txt b/docs/.sphinx/requirements.txt → docs/sphinx/requirements.txt
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,7 +15,7 @@ To build our documentation locally, use the following code: @@
     ```Bash
     cd docs
-    pip3 install -r .sphinx/requirements.txt
+    pip3 install -r sphinx/requirements.txt
     python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
     ```
@@ Expand Down @@