Unverified Commit aa6a1d13 authored by Jacob Cain's avatar Jacob Cain Committed by GitHub
Browse files

Docs pruning (#5628) 

* remove unused readthedocs template

* Doxygen API Docs, header and footer, remove depreciated config

* remove old vis

* remove homepage windowing js

* remove feed2js

* remove progtest docs

* remove isishistory and 'documents' structure

* remove old vis (part 2)

* remove unused toc and more unused javascripts

* remove one more utility js reference

* moved one-line files to inline in other files

* menu arrow fix for api docs

* move moon surface banner to be with rest of images

* reorganized images

* use menupath variable in more places

* remove unused blackborderimage css

* js.map files

* favicon

* css category fix

* css category fix part 2

* css category fix part 3
parent 6e579588

.readthedocs.yaml

deleted100644 → 0
+0 −18
Original line number Diff line number Diff line 
# .readthedocs.yaml

# Read the Docs configuration file

# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details



# Required

version: 2



# Build documentation in the docs/ directory with Sphinx

sphinx:

   configuration: rtd_docs/conf.py



# Optionally build your docs in additional formats such as PDF

formats:

   - pdf



conda:

  environment: rtd_docs/environment.yml

isis/cmake/BuildDocs.cmake

+5 −89
Original line number Diff line number Diff line
@@ -73,93 +73,14 @@ function(build_upper_level) 
  # Create the main documentaion page. This is located in the version directory 

  execute_process(COMMAND ${XALAN} ${XALAN_VALIDATE_OPTION} ${XALAN_PARAM_OPTION} menuPath \"\" ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/${docVersion}/index.html ${XALAN_INFILE_OPTION} ${docBuildFolder}/build/homepage.xml ${XALAN_XSL_OPTION} ${docBuildFolder}/build/main.xsl)



  # Copy Favicon

  file(COPY ${docBuildFolder}/favicon.ico DESTINATION ${docInstallFolder}/${docVersion}/favicon.ico)



endfunction(build_upper_level)











# Build src/docsys/documents folder.

function(build_documents_folder)



  message("Building documents folder...")

  message("    Building table of contents XML...")



  # Create RealeaseNotes.xml, ApiChanges.xml and ParameterChanges.xml if need-be

  if(EXISTS "${docBuildFolder}/documents/ReleaseNotes/ReleaseNotesList.xml")

    execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} dirParam \"ReleaseNotes\" ${XALAN_INFILE_OPTION} ${docBuildFolder}/documents/ReleaseNotes/ReleaseNotesList.xml ${XALAN_XSL_OPTION} ${docBuildFolder}/build/ReleaseNotes.xsl OUTPUT_FILE ${docBuildFolder}/documents/ReleaseNotes/ReleaseNotes.xml)

    execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} dirParam \"ParameterChanges\" ${XALAN_INFILE_OPTION} ${docBuildFolder}/documents/ReleaseNotes/ReleaseNotesList.xml ${XALAN_XSL_OPTION} ${docBuildFolder}/build/ParameterChanges.xsl OUTPUT_FILE ${docBuildFolder}/documents/ParameterChanges/ParameterChanges.xml)

    execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} dirParam \"ApiChanges\" ${XALAN_INFILE_OPTION} ${docBuildFolder}/documents/ReleaseNotes/ReleaseNotesList.xml ${XALAN_XSL_OPTION} ${docBuildFolder}/build/ApiChanges.xsl OUTPUT_FILE ${docBuildFolder}/documents/ApiChanges/ApiChanges.xml)

  else()

    # Confirm that empty directories are not going to be traversed in loops coming up

    message("    ReleaseNotesList.xml does not exist. Removing ReleaseNotes/ ParameterChanges/ and ApiChanges/ directories...")

    execute_process(COMMAND rm -rf ${docBuildFolder}/documents/ReleaseNotes ${docBuildFolder}/documents/ParameterChanges ${docBuildFolder}/documents/ApiChanges)

  endif()



  # Get list of folders of interest

  get_subdirectory_list(${docBuildFolder}/documents docFolders)



  # Build doctoc.xml, the documents table of contents file.

  set(doctocPath ${docBuildFolder}/build/doctoc.xml)

  file(REMOVE ${doctocPath})

  cat(${docBuildFolder}/build/doctoc_header.xml ${doctocPath})

  foreach(f ${docFolders})

    

    # Each folder in documents gets a section added to doctoc

    get_filename_component(docName ${f} NAME_WE)

    

    execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} dirParam \"${docName}\"  ${XALAN_INFILE_OPTION} ${f}/${docName}.xml ${XALAN_XSL_OPTION} ${docBuildFolder}/build/IsisDocumentTOCbuild.xsl OUTPUT_VARIABLE result)

    file(APPEND ${doctocPath} ${result})



  endforeach()

  cat(${docBuildFolder}/build/doctoc_footer.xml ${doctocPath})



  # Write out a modified .xsl file with the correct location of the Xalan executable.

  set(modDocBuildXslFile ${docBuildFolder}/build/IsisInlineDocumentBuild_mod.xsl)

  file(READ ${PROJECT_SOURCE_DIR}/scripts/IsisInlineDocumentBuild_mod.xsl xslContents)

  string(REPLACE XALAN_BIN_LOCATION ${XALAN} xslContents "${xslContents}")

  file(WRITE ${modDocBuildXslFile} "${xslContents}")



  # Build individual documents folders

  message("    Building individual documents...")

  file(MAKE_DIRECTORY ${docInstallFolder}/${docVersion}/documents)

  foreach(f ${docFolders})



    message("Building documents folder: ${f}")



    # Handle paths for this folder

    get_filename_component(docName ${f} NAME_WE)

    set(thisOutputFolder ${docInstallFolder}/${docVersion}/documents/${docName})

    file(MAKE_DIRECTORY ${thisOutputFolder})



    # Use Xalan to generate an intermediate makefile, then execute that makefile

    # to generate the output documentation files.



    set(xalanCommand ${XALAN} ${XALAN_PARAM_OPTION} menuPath "../../" ${XALAN_PARAM_OPTION} dirParam "'${docName}'" ${XALAN_OUTFILE_OPTION} ${f}/Makefile_temp ${XALAN_INFILE_OPTION} ${docName}.xml  ${XALAN_XSL_OPTION} ${modDocBuildXslFile})

    execute_process(COMMAND ${xalanCommand} WORKING_DIRECTORY ${f})



    execute_process(COMMAND make -f Makefile_temp docs WORKING_DIRECTORY ${f})

    execute_process(COMMAND rm -f ${f}/Makefile_temp) # Clean up



    # Copy all generated html files and any assets to the install folder

    file(GLOB htmlFiles ${f}/*.html)

    file(COPY ${htmlFiles} DESTINATION ${thisOutputFolder})

    if(EXISTS "${f}/assets")

      copy_folder(${f}/assets ${thisOutputFolder}/assets)

    endif()

    if(EXISTS "${f}/images")

      copy_folder(${f}/images ${thisOutputFolder}/images)

    endif()



  endforeach()



endfunction(build_documents_folder)











# Supporting files should already be in /src/docsys/Application

function(build_application_docs)
@@ -206,7 +127,7 @@ function(build_application_docs) 
  # Set up the file

  set(appTocPath "${CMAKE_INSTALL_PREFIX}/bin/xml/applicationTOC.xml")

  file(REMOVE ${appTocPath})

  cat(${docBuildFolder}/Application/build/toc_header.xml ${appTocPath})

  file(APPEND ${appTocPath} "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><tableofcontents>")

  get_subdirectory_list(${appDataFolder} moduleFolders)



  # Loop through module folders
@@ -225,8 +146,8 @@ function(build_application_docs) 
    endforeach()

  endforeach()



  # Append the footer to complete the TOC file!

  cat(${docBuildFolder}/Application/build/toc_footer.xml ${appTocPath})

  # Append closing tag to complete the TOC file

  file(APPEND ${appTocPath} "</tableofcontents>")



endfunction(build_application_docs)
@@ -297,7 +218,6 @@ function(build_object_conf) 
  file(APPEND ${appsConf} "INPUT            = ${PROJECT_SOURCE_DIR}/src/ ${objConfDir}/isisDoxyDefs.doxydef\n")

  file(APPEND ${appsConf} "HTML_HEADER      = ${objConfDir}/IsisObjectHeader.html\n")

  file(APPEND ${appsConf} "HTML_FOOTER      = ${objConfDir}/IsisObjectFooter.html\n")

  file(APPEND ${appsConf} "PROJECT_LOGO     = ${docBuildFolder}/assets/icons/USGS_logo55h.png\n")

  file(APPEND ${appsConf} "HTML_OUTPUT      = apps\n")



  if(NOT ${DOT_PATH} STREQUAL "")
@@ -314,7 +234,6 @@ function(build_object_conf) 
  file(APPEND ${programmerConf} "INPUT            = ${PROJECT_SOURCE_DIR}/src/ ${objConfDir}/isisDoxyDefs.doxydef\n")

  file(APPEND ${programmerConf} "HTML_HEADER      = ${objConfDir}/IsisObjectHeader.html\n")

  file(APPEND ${programmerConf} "HTML_FOOTER      = ${objConfDir}/IsisObjectFooter.html\n")

  file(APPEND ${programmerConf} "PROJECT_LOGO     = ${docBuildFolder}/assets/icons/USGS_logo55h.png\n")

  file(APPEND ${programmerConf} "HTML_OUTPUT      = Programmer\n")

  file(APPEND ${programmerConf} "IMAGE_PATH       = \n")
@@ -348,7 +267,6 @@ function(build_object_conf) 
  file(APPEND ${developerConf} "INPUT            = ${PROJECT_SOURCE_DIR}/src/ ${objConfDir}/isisDoxyDefs.doxydef\n")

  file(APPEND ${developerConf} "HTML_HEADER      = ${objConfDir}/IsisObjectHeader.html\n")

  file(APPEND ${developerConf} "HTML_FOOTER      = ${objConfDir}/IsisObjectFooter.html\n")

  file(APPEND ${developerConf} "PROJECT_LOGO     = ${docBuildFolder}/assets/icons/USGS_logo55h.png\n")

  file(APPEND ${developerConf} "HTML_OUTPUT      = Developer\n")

  file(APPEND ${developerConf} "IMAGE_PATH       = \n")

  string(FIND "${MODE}" "LOUD" pos)
@@ -454,8 +372,6 @@ function(build_docs) 
  message("Building upper level directories...")

  build_upper_level()



  build_documents_folder()



  message("Building application docs...")

  build_application_docs()

isis/make/isismake.apps

+0 −6
Original line number Diff line number Diff line
@@ -89,9 +89,6 @@ $(BINS): $(UIHEADERS) $(QTRESOURCEFILES) protos $(OBJS) 
	export PATH="$(CODE_COVERAGE_PATH_DIR):$$PATH"; \

	$(CXX) $(ALLINCDIRS) $(ISISCPPFLAGS) $(ISIS_PROTOBUF_FLAGS) -c -o $@ $?



.xml.html :

	$(XALAN) $(XALAN_VALIDATE_OPTION) $(XALAN_OUTFILE_OPTION) $@ $(XALAN_INFILE_OPTION) $? $(XALAN_XSL_OPTION) $(ISISROOT)/src/docsys/Application/presentation/ProgTester/IsisApplicationDocStyle.xsl



protos: $(PROTOS:%.proto=%.pb.h) $(PROTOS:%.proto=%.pb.cc)



%.pb.cc %.pb.h: %.proto
@@ -170,9 +167,6 @@ install: app 
	fi





validxml:

	$(XALAN) $(XALAN_VALIDATE_OPTION) $(XALAN_OUTFILE_OPTION) /dev/null $(XALAN_INFILE_OPTION) $(BINS).xml $(XALAN_XSL_OPTION) $(ISISROOT)/src/docsys/Application/presentation/ProgTester/IsisApplicationDocStyle.xsl;



docs:

	mkdir -p $(ISISROOT)/src/docsys/Application/data/`basename $(CURDIR)`

	cp -p `basename $(CURDIR)`.xml $(ISISROOT)/src/docsys/Application/data/`basename $(CURDIR)`

isis/make/isismake.objs

+0 −3
Original line number Diff line number Diff line
@@ -172,7 +172,6 @@ help: 
	echo "make plugin                     : Builds a plugin object if applicable"

	echo "make install                    : Calls the make target and copies the object and"

	echo "                                    plugin to $ISISROOT/..."

	echo "make html                       : Builds the html page for the object"

	echo "make clean                      : Removes the application, *.html and *.o files."

	echo "                                    Also cleans the test directories"

	echo "make sanitize                   : Calls the clean target then removes tttt* junk.*"
@@ -187,8 +186,6 @@ help: 
	echo "make protos                     : Builds the object of google protocol buffer(*.proto) files"



TEMPDIR:=${CURDIR}

html: force

	(cd $(ISISROOT)/src/docsys/Object/ ; make CURDIR=$(TEMPDIR) doProgTest )



clean:  localclean

	$(RM) $(OBJS) $(PROTOSGEN) $(MOCGEN) unitTest.o unitTest print.prt    \

isis/src/docsys/Application/build/TOCindex.xsl

deleted100644 → 0
+0 −293
Original line number Diff line number Diff line 
<?xml version="1.0" encoding="UTF-8"?>

<xsl:stylesheet version="1.0"

    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"

    xmlns:fo="http://www.w3.org/1999/XSL/Format"

    exclude-result-prefixes="xmlns fo">



<!--



This stylesheet will be used to generate the main TOC for applications



Author

Deborah Lee Soltesz

4/2002



-->





  <xsl:output

    media-type="text/html"

    doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"

    doctype-system="http://www.w3.org/TR/html4/loose.dtd"

    indent="yes"

    encoding="utf-8"

    omit-xml-declaration="yes"/>





  <xsl:include href="../../build/menu.xsl"/>





  <xsl:key name="categoryMatch" match="/tableofcontents/application" use="category/categoryItem"/>





  <xsl:template match="/">

     <xsl:apply-templates select="tableofcontents" />

  </xsl:template>





  <xsl:template match="tableofcontents">

    <html>

      <head>

        <title>

            USGS: ISIS Application Table of Contents

        </title>

        <link rel="stylesheet" href="../assets/styles/IsisStyleCommon.css"></link>

        <link rel="stylesheet" media="print" href="../assets/styles/print.css"/>



        <meta name="keywords" content="Isis, applications, table of contents, image processing"/>



        <meta name="description" content="Isis Applications Table of Contents"/>

        <meta name="publisher" content="USGS - GD - Astrogeology Research Program"/>

        <meta name="author" content="Deborah Lee Soltesz, webteam@astrogeology.usgs.gov"/>



        <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>

        <meta name="country" content="USA"/>

        <meta name="state" content="AZ"/>

        <meta name="county" content="Coconino"/>

        <meta name="city" content="Flagstaff"/>

        <meta name="zip" content="86001"/>



        <!-- Dynamic analytics insertion to prevent running on local URLs -->

        <xsl:text>&#xa;</xsl:text>

        <script type="text/javascript">

          //<xsl:comment><![CDATA[

          (function() {

            var usgsAnalytics = document.createElement('script');

            usgsAnalytics.type = 'text/javascript';

            usgsAnalytics.async = true;

            usgsAnalytics.src = 'http://www.usgs.gov/scripts/analytics/usgs-analytics.js';

            if('http:' == document.location.protocol) {

              var s = document.getElementsByTagName('script')[0];

              s.parentNode.insertBefore(usgsAnalytics, s);

            }

          })();

          ]]></xsl:comment>

        <xsl:text>&#xa;</xsl:text>

        </script>



       </head>



      <body>



        <div class="isisMenu">

         <xsl:call-template  name="writeMenu"/>

        </div>



        <div class="isisContent">



        <a href="http://www.usgs.gov">

        <img src="../assets/icons/littleVIS.gif" width="80" height="22" border="0" alt="USGS"/></a><br/>





        <p style="margin-top:10px; margin-bottom:0px;">

        ISIS Application Documentation</p>



        <hr/>





        <table width="100%" cellpadding="0" border="0" cellspacing="0">

          <tr valign="top">

            <td align="left">

              <h1>

                Table of Contents

              </h1>

            </td>

            <td align="right" class="caption">

            <a href="../index.html">Home</a>

            </td>

          </tr>

        </table>



<!-- links to categories -->

      <h3>Categories</h3>

      <h4><a href="'#Core">Core Programs</a></h4>

      <ul>

          <xsl:for-each select="//application/category/categoryItem[not(normalize-space(.)=preceding::application/category/categoryItem)]">

            <xsl:sort order="ascending" select="normalize-space(.)"/>

              <li>

                <a href="#{normalize-space(.)}">

                <xsl:value-of select="." /></a>

              </li>

          </xsl:for-each>

              <li><a href="#Alphabetical">

              Alphabetical Listing</a></li>

              <li><a href="#OldNames">

              Old Application Names vs. New Application Names</a></li>

      </ul>



      <h4><a href="#MissionSpecific">Mission Specific Programs</a></h4>

      <ul>

          <xsl:for-each select="//application/category/missionItem[not(normalize-space(.)=preceding::application/category/missionItem)]">

            <xsl:sort order="ascending" select="normalize-space(.)"/>

              <li>

                <a href="#{normalize-space(.)}">

                <xsl:value-of select="." /></a>

              </li>

          </xsl:for-each>

              <li><a href="#Alphabetical">

              Alphabetical Listing</a></li>

              <li><a href="#OldNames">

              Old Application Names vs. New Application Names</a></li>

      </ul>





<!-- tables of links to documentation -->



      <a name="Core"></a>

      <hr noshade="noshade"/>

      <h2>Core Programs</h2>

      <xsl:for-each select="//application/category/categoryItem[not(normalize-space(.)=preceding::application/category/categoryItem)]">

            <xsl:sort order="ascending" select="normalize-space(.)"/>

            <hr noshade="noshade"/>

            <h3>

            <a name="{normalize-space(.)}">

            <xsl:value-of select="."/>

            </a>

            </h3>

            <xsl:variable name="categoryName" select="normalize-space(.)"/>



            <table>

            <xsl:for-each select="/tableofcontents/application/category/categoryItem">

              <xsl:if test="normalize-space(.) = $categoryName">

                <tr>

                  <th class="tableCellLevel1_th">

                    <xsl:variable name="appName" select="normalize-space(../../name)"/>

                    <a href="presentation/Tabbed/{$appName}/{$appName}.html">

                    <xsl:value-of select="../../name"/></a>

                  </th>

                  <td class="tableCellLevel1">

                    <xsl:value-of select="../../brief"/><br/>

                  </td>

                </tr>

              </xsl:if>

            </xsl:for-each>

            </table>

       </xsl:for-each>



      <a name="MissionSpecific"></a>

      <hr noshade="noshade"/>

      <h2>Mission Specific Programs</h2>

      <xsl:for-each select="//application/category/missionItem[not(normalize-space(.)=preceding::application/category/missionItem)]">

            <xsl:sort order="ascending" select="normalize-space(.)"/>

            <hr/>

            <h3>

            <a name="{normalize-space(.)}">

            <xsl:value-of select="."/>

            </a>

            </h3>

            <xsl:variable name="missionName" select="normalize-space(.)"/>



            <table>

            <xsl:for-each select="/tableofcontents/application/category/missionItem">

              <xsl:if test="normalize-space(.) = $missionName">

                <tr>

                  <th class="tableCellLevel1_th">

                    <xsl:variable name="appName" select="normalize-space(../../name)"/>

                    <a href="presentation/Tabbed/{$appName}/{$appName}.html">

                    <xsl:value-of select="../../name"/></a>

                  </th>

                  <td class="tableCellLevel1">

                    <xsl:value-of select="../../brief"/><br/>

                  </td>

                </tr>

              </xsl:if>

            </xsl:for-each>

            </table>

      </xsl:for-each>



<!-- Alphabetical tables of links to documentation -->

      <a name="Alphabetical"></a>

      <hr noshade="noshade"/>

      <h2>Alphabetical Listing</h2>



            <table>

            <xsl:for-each select="/tableofcontents/application">

              <xsl:sort order="ascending" select="name"/>

                <tr>

                  <th class="tableCellLevel1_th">

                    <xsl:variable name="appName" select="normalize-space(name)"/>

                    <a href="presentation/Tabbed/{$appName}/{$appName}.html">

                    <xsl:value-of select="$appName"/></a>

                  </th>

                  <td class="tableCellLevel1">

                    <xsl:if test="brief">

                    <xsl:value-of select="brief"/><br/>

                    </xsl:if>

                  </td>

                </tr>

            </xsl:for-each>

            </table>





<!-- tables of links to documentation matching old names to new names -->

      <a name="OldNames"></a>

      <hr noshade="noshade"/>

      <h2>Old Names vs. New Names</h2>



      <table>

        <tr>

          <th class="tableCellLevel1_th">

            Old Name

          </th>

          <th class="tableCellLevel1_th">

            New Name(s)

          </th>

        </tr>



        <xsl:for-each select="//application/oldName/item[not(normalize-space(.)=preceding::application/oldName/item)]">

            <xsl:sort order="ascending" select="normalize-space(.)"/>

            <xsl:variable name="oldIsisName" select="normalize-space(.)"/>

                <tr>

                  <td class="tableCellLevel1" valign="top">

                    <xsl:value-of select="."/>

                  </td>

                  <td class="tableCellLevel1" valign="top">

                    <ul>

                    <xsl:for-each select="//application/oldName/item">

                      <xsl:if test="normalize-space(.) = $oldIsisName">

                        <li>

                        <xsl:variable name="appName" select="normalize-space(../../name)"/>

                        <a href="presentation/Tabbed/{$appName}/{$appName}.html">

                        <xsl:value-of select="../../name"/></a>

                        </li>

                      </xsl:if>

                    </xsl:for-each>

                    </ul>

                  </td>

                </tr>

        </xsl:for-each>

      </table>

























<!-- FOOTER -->

<script type="text/javascript" language="JavaScript" src="../assets/scripts/footer.js"></script>

</div>







      </body>

    </html>



  </xsl:template>



</xsl:stylesheet>