Move everything doxygen-related to a new subdirectory.

Should help keep reference docs more clearly separated from technical docs. Signed-off-by: Patrick Vacek <patrickvacek@gmail.com>
advancedtelematic · Aug 21, 2019 · 946e4e7 · 946e4e7
1 parent 23d2701
commit 946e4e7
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 4 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -412,7 +412,7 @@ if(BUILD_PARTIAL)
 endif()
 add_subdirectory("tests" EXCLUDE_FROM_ALL)
 
-add_subdirectory("docs")
+add_subdirectory("docs/doxygen")
 
 # Check if some source files were not added sent to `aktualizr_source_file_checks`
 #

diff --git a/docs/README.adoc b/docs/README.adoc
@@ -36,7 +36,7 @@ To update the doxygen documentation for master on github, you will need to do so
 1. In an aktualizr repo, run `make doxygen` (or `make docs`) in the build directory.
 1. Clone a second aktualizr repo and run `git checkout gh-pages`.
 1. In the second repo, run `git rm search/* *.css *.html *.js *.png *.map *.md5 *.png *.svg`.
-1. Copy the contents of `<build_dir>/docs/html` into the root of the second repo. (Something like `cp -a <build_dir>/docs/html/* <second_repo>`.)
+1. Copy the contents of `<build_dir>/docs/doxygen/html` into the root of the second repo. (Something like `cp -a <build_dir>/docs/doxygen/html/* <second_repo>`.)
 1. In the second repo, run `git add .`, `git commit -as`, and `git push`.
 1. Wait a minute or two for github to refresh and render the files.
 
@@ -56,6 +56,6 @@ make doxygen
 +
 1. Clone a second aktualizr repo and run `git checkout gh-pages`.
 1. In the second repo, make a directory for the tag or commit you wish to add, i.e. `mkdir 2018.63`.
-1. Copy the contents of `<build_dir>/docs/html` into the directory you just created. (Something like `cp -a <build_dir>/docs/html/* <second_repo>/2018.63`.)
+1. Copy the contents of `<build_dir>/docs/doxygen/html` into the directory you just created. (Something like `cp -a <build_dir>/docs/doxygen/html/* <second_repo>/2018.63`.)
 1. In the second repo, run `git add 2018.63`, `git commit -as`, and `git push`.
 1. Wait a minute or two for github to refresh and render the files.
diff --git a/docs/CMakeLists.txt → docs/doxygen/CMakeLists.txt b/docs/CMakeLists.txt → docs/doxygen/CMakeLists.txt
diff --git a/docs/Doxyfile.in → docs/doxygen/Doxyfile.in b/docs/Doxyfile.in → docs/doxygen/Doxyfile.in
@@ -796,6 +796,7 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = @CMAKE_SOURCE_DIR@/docs \
+                         @CMAKE_SOURCE_DIR@/docs/doxygen \
                          @CMAKE_SOURCE_DIR@/tests \
                          @CMAKE_SOURCE_DIR@/src/aktualizr_get \
                          @CMAKE_SOURCE_DIR@/src/aktualizr_info \
@@ -1004,7 +1005,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = @CMAKE_SOURCE_DIR@/docs/INDEX.md
+USE_MDFILE_AS_MAINPAGE = @CMAKE_SOURCE_DIR@/docs/doxygen/INDEX.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

diff --git a/docs/INDEX.md → docs/doxygen/INDEX.md b/docs/INDEX.md → docs/doxygen/INDEX.md