change docs back to doc

joachim-tsakanikas · Jun 22, 2021 · 3753846 · 3753846
1 parent 8dc362e
commit 3753846
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 21 deletions.
diff --git a/.github/workflows/doxygen-6.0.yml b/.github/workflows/doxygen-6.0.yml
@@ -20,7 +20,7 @@ jobs:
         uses: mattnotmitt/[email protected]
         with:
             working-directory: '.'
-            doxyfile-path: 'docs/doxygen/DoxyfileC'
+            doxyfile-path: 'doc/doxygen/DoxyfileC'
 
       # store the C doxygen files
       - name: Upload Output Directory

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -309,14 +309,14 @@ if( DOXYGEN_FOUND )
     set(DOXYGEN_SHOW_GROUPED_MEMB_INC YES)
     set(DOXYGEN_INLINE_IHERITED_MEMB YES)
     set(DOXYGEN_JAVADOC_AUTOBRIEF YES)
-    set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/docs/doxygen/CC)
+    set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen/CC)
 
     # Add target of "docCC"
     doxygen_add_docs(docCC src/libsrc++)
 
     # Change these values from cmake defaults in the Doxyfile
     set(DOXYGEN_OPTIMIZE_OUTPUT_FOR_C YES)
-    set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/docs/doxygen/C)
+    set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen/C)
 
     # Add target of "docC"
     doxygen_add_docs(docC src/libsrc )

diff --git a/README.md b/README.md
@@ -33,9 +33,6 @@ you can skip the C/C++ installation.
 
   https://github.com/JeffersonLab/JEventViewer
 
-# **Trial link**
-   https://jeffersonlab.github.io/evio/
-
 -----------------------------
 ## **Documentation**
 
@@ -166,8 +163,8 @@ run _**scons -h**_ in the top-level directory to get this output:
     --bindir=<dir>           copy binary files to directory <dir> when doing install 
     install                  install libs, headers, and binaries
     install -c               uninstall libs, headers, and binaries
-    doc                      create doxygen and javadoc (in ./docs)
-    undoc                    remove doxygen and javadoc (in ./docs)
+    doc                      create doxygen and javadoc (in ./doc)
+    undoc                    remove doxygen and javadoc (in ./doc)
     tar                      create tar file (in ./tar)
 
     Use scons -H for help about command-line options.

diff --git a/SConstruct b/SConstruct
@@ -259,10 +259,10 @@ if 'undoc' in COMMAND_LINE_TARGETS:
 
 
 # use "doc" on command line to create tar file
-Help('doc                 create doxygen and javadoc (in ./docs)\n')
+Help('doc                 create doxygen and javadoc (in ./doc)\n')
 
 # use "undoc" on command line to create tar file
-Help('undoc               remove doxygen and javadoc (in ./docs)\n')
+Help('undoc               remove doxygen and javadoc (in ./doc)\n')
 
 
 #########################

diff --git a/build.xml b/build.xml
@@ -16,7 +16,7 @@
     <property name="build.dir"     value="build" />
     <property name="build.classes" value="${build.dir}/classes" />
     <property name="build.lib"     value="${build.dir}/lib" />
-    <property name="doc.dir"       value="docs/javadoc" />
+    <property name="doc.dir"       value="doc/javadoc" />
     <property name="local.jars"    value="java/jars" />
 
     <property name="jarName"       value="jevio-${evio.version}.jar" />

diff --git a/coda.py b/coda.py
@@ -329,39 +329,39 @@ def generateDocs(env, doCPP=False, doC=False, doJava=False):
     if doCPP:
         print ('Call generateDocs() for C++')
         # remove target files so documentation always gets rebuilt
-        rmcmd = 'rm -fr docs/doxygen/CC'
+        rmcmd = 'rm -fr doc/doxygen/CC'
         os.popen(rmcmd).read()
 
         def docGeneratorCC(target, source, env):
-            cmd = 'doxygen docs/doxygen/DoxyfileCC'
+            cmd = 'doxygen doc/doxygen/DoxyfileCC'
             Popen(cmd, shell=True, env={"TOPLEVEL": "./"}, stdout=None)
             return
 
         docBuildCC = Builder(action = docGeneratorCC)
         env.Append(BUILDERS = {'DocGenCC' : docBuildCC})
 
-        env.Alias('doc', env.DocGenCC(target = ['#/docs/doxygen/CC/html/index.html'],
+        env.Alias('doc', env.DocGenCC(target = ['#/doc/doxygen/CC/html/index.html'],
                                       source = scanFiles("src/libsrc++", accept=["*.cpp", "*.h"])))
 
 
     if doC:
-        rmcmd = 'rm -fr docs/doxygen/C'
+        rmcmd = 'rm -fr doc/doxygen/C'
         os.popen(rmcmd).read()
 
         def docGeneratorC(target, source, env):
-            cmd = 'doxygen docs/doxygen/DoxyfileC'
+            cmd = 'doxygen doc/doxygen/DoxyfileC'
             Popen(cmd, shell=True, env={"TOPLEVEL": "./"}, stdout=None)
             return
 
         docBuildC = Builder(action = docGeneratorC)
         env.Append(BUILDERS = {'DocGenC' : docBuildC})
 
-        env.Alias('doc', env.DocGenC(target = ['#/docs/doxygen/C/html/index.html'],
+        env.Alias('doc', env.DocGenC(target = ['#/doc/doxygen/C/html/index.html'],
                                       source = scanFiles("src/libsrc", accept=["*.c", "*.h"])))
 
 
     if doJava:
-        rmcmd = 'rm -fr docs/javadoc'
+        rmcmd = 'rm -fr doc/javadoc'
         os.popen(rmcmd).read()
 
         def docGeneratorJava(target, source, env):
@@ -372,7 +372,7 @@ def docGeneratorJava(target, source, env):
         docBuildJava = Builder(action = docGeneratorJava)
         env.Append(BUILDERS = {'DocGenJava' : docBuildJava})
 
-        env.Alias('doc', env.DocGenJava(target = ['#/docs/javadoc/index.html'],
+        env.Alias('doc', env.DocGenJava(target = ['#/doc/javadoc/index.html'],
             source = scanFiles("java/org/jlab/coda", accept=["*.java"]) ))
 
     return 1

diff --git a/docs/doxygen/DoxyfileC b/docs/doxygen/DoxyfileC
@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = ./docs/doxygen/C
+OUTPUT_DIRECTORY       = ./doc/doxygen/C
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and

diff --git a/docs/doxygen/DoxyfileCC b/docs/doxygen/DoxyfileCC
@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = ./docs/doxygen/CC
+OUTPUT_DIRECTORY       = ./doc/doxygen/CC
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and