Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen updates dev #108

Merged
merged 7 commits into from
Dec 11, 2023
Merged

Doxygen updates dev #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3a6a365
Update Doxygen configuration
pelesh Dec 8, 2023
0b7cbfc
Updated license info.
pelesh Dec 8, 2023
97db786
Update copyright notice format.
pelesh Dec 8, 2023
2ae99c6
Minor cleanup
pelesh Dec 9, 2023
aafef6b
Fine-tune doxygen configuration.
pelesh Dec 10, 2023
68ac832
Use Awesome JavaScripts.
pelesh Dec 11, 2023
a750401
Update doxygen main page.
pelesh Dec 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 5 additions & 34 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,41 +55,12 @@ list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
# TODO: Set up clang-format
#include(./cmake/clang-format)

# This will create target `doxygen` for building documentation locally.
# For now, this target is intended only for developers who want to test
# different documentation configurations. To have Doxygen configuration
# changed at readthedocs, update `docs/doxygen/Doxyfile.in` accordingly.
if (RESOLVE_USE_DOXYGEN)
find_package(Doxygen)
endif()

if ( DOXYGEN_FOUND )
set( DOXYGEN_OUTPUT_DIRECTORY ./sphinx/_build/doxygen )
set( DOXYGEN_COLLABORATION_GRAPH YES )
set( DOXYGEN_EXTRACT_ALL YES )
set( DOXYGEN_CLASS_DIAGRAMS YES )
set( DOXYGEN_HIDE_UNDOC_RELATIONS NO )
set( DOXYGEN_HAVE_DOT YES )
set( DOXYGEN_CLASS_GRAPH YES )
set( DOXYGEN_CALL_GRAPH YES )
set( DOXYGEN_CALLER_GRAPH YES )
set( DOXYGEN_COLLABORATION_GRAPH YES )
set( DOXYGEN_BUILTIN_STL_SUPPORT YES )
set( DOXYGEN_EXTRACT_PRIVATE YES )
set( DOXYGEN_EXTRACT_PACKAGE YES )
set( DOXYGEN_EXTRACT_STATIC YES )
set( DOXYGEN_EXTRACT_LOCALMETHODS YES )
set( DOXYGEN_UML_LOOK YES )
set( DOXYGEN_UML_LIMIT_NUM_FIELDS 50 )
set( DOXYGEN_TEMPLATE_RELATIONS YES )
set( DOXYGEN_DOT_GRAPH_MAX_NODES 100 )
set( DOXYGEN_MAX_DOT_GRAPH_DEPTH 0 )
set( DOXYGEN_DOT_TRANSPARENT YES )
set(DOXYGEN_DISABLE_INDEX NO)
set(DOXYGEN_FULL_SIDEBAR NO)
set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_HTML_EXTRA_STYLESHEET "./docs/doxygen/doxygen-awesome-css/doxygen-awesome.css")
set(DOXYGEN_HTML_COLORSTYLE LIGHT)
doxygen_add_docs( doxygen ${RPP_PROJECT_SOURCE_DIR} )

else()
message( "Doxygen need to be installed to generate the doxygen documentation" )
include(ReSolveFindDoxygen)
endif()


Expand Down
57 changes: 25 additions & 32 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,55 +1,48 @@
Copyright (c) 2023, UT-Battelle, LLC, and Battelle Memorial Institute
All rights reserved
Copyright (c) 2023, UT-Battelle, LLC and Battelle Memorial Institute.
All rights reserved.

ReSolve version 1.0

License:
Open Source License:

Subject to the conditions of this License, UT-Battelle, LLC (the “Licensor”)
hereby grants, free of charge, to any person (the “Licensee”) obtaining a copy
Subject to the conditions of this License, UT-Battelle, LLC and Battelle
Memorial Institute hereby grant, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), a
perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to use, copy, modify, merge, publish, distribute, and/or
sublicense copies of the Software.

1. Redistributions of Software must retain the above open source license grant,
copyright and license notices, this list of conditions, and the disclaimer
listed below. Changes or modifications to, or derivative works of the Software
must be noted with comments and the contributor and organization’s name. If
the Software is protected by a proprietary trademark owned by Licensor or the
Department of Energy, then derivative works of the Software may not be
distributed using the trademark without the prior written approval of the
trademark owner.
listed below. Changes or modifications to, or derivative works of the
Software must be noted with comments and the contributor and organization’s
name. If the Software is protected by a proprietary trademark owned by
UT-Battelle, LLC or Battelle Memorial Institute or the Department of Energy,
then derivative works of the Software may not be distributed using the
trademark without the prior written approval of the trademark owner.

2. Neither the names of Licensor nor the Department of Energy may be used to
endorse or promote products derived from this Software without their specific
prior written permission.

3. The Software, with or without modification, must include the following
acknowledgment:

"This product includes software produced by UT-Battelle, LLC under Contract
"This product includes software produced by UT-Battelle, LLC under Contract
No. DE-AC05-00OR22725 and Battelle Memorial Institute under Contract
No. DE-AC05-76RL01830 with the Department of Energy.”

4. Licensee agrees to unconditionally assign to Licensor all rights in any
changes or modifications to, or derivative works of the Software. Licensee
agrees to furnish the Licensor within a reasonable time a copy of any changes
or modifications to, or derivative works of the Software according to the
instructions found on the following web site:

https://github.com/ORNL/resolve


******************************************************************************
DISCLAIMER

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
UT-BATTELLE, LLC, BATTELLE MEMORIAL INSTITUTE, AND THE GOVERNMENT MAKE NO
REPRESENTATIONS AND DISCLAIM ALL WARRANTIES, BOTH EXPRESSED AND IMPLIED.
THERE ARE NO EXPRESS OR IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR
A PARTICULAR PURPOSE, OR THAT THE USE OF THE SOFTWARE WILL NOT INFRINGE ANY
PATENT, COPYRIGHT, TRADEMARK, OR OTHER PROPRIETARY RIGHTS, OR THAT THE SOFTWARE
WILL ACCOMPLISH THE INTENDED RESULTS OR THAT THE SOFTWARE OR ITS USE WILL NOT
RESULT IN INJURY OR DAMAGE. THE USER ASSUMES RESPONSIBILITY FOR ALL
LIABILITIES, PENALTIES, FINES, CLAIMS, CAUSES OF ACTION, AND COSTS AND
EXPENSES, CAUSED BY, RESULTING FROM OR ARISING OUT OF, IN WHOLE OR IN PART
THE USE, STORAGE OR DISPOSAL OF THE SOFTWARE.
22 changes: 9 additions & 13 deletions NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,14 @@ Institute. The views and opinions of authors expressed herein do not
necessarily state or reflect those of the United States Government or any
agency thereof.

OAK RIDGE NATIONAL LABORATORY
operated by
UT-BATTELLE
for the
UNITED STATES DEPARTMENT OF ENERGY
under Contract DE-AC05-00OR22725
OAK RIDGE NATIONAL LABORATORY
operated by UT-BATTELLE for the
UNITED STATES DEPARTMENT OF ENERGY
under Contract DE-AC05-00OR22725

and
and

PACIFIC NORTHWEST NATIONAL LABORATORY
operated by
BATTELLE MEMORIAL INSTITUTE
for the
UNITED STATES DEPARTMENT OF ENERGY
under Contract DE-AC05-76RL01830
PACIFIC NORTHWEST NATIONAL LABORATORY
operated by BATTELLE MEMORIAL INSTITUTE for the
UNITED STATES DEPARTMENT OF ENERGY
under Contract DE-AC05-76RL01830
60 changes: 60 additions & 0 deletions cmake/ReSolveFindDoxygen.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
#[[

Looks for Doxygen tool and, if found, created `doxygen` target.

Command `make doxygen` will create Doxygen documentation in the
`doxygen` subdirectory within ReSolve build directory.

@author Slaven Peles ([email protected])

]]
find_package(Doxygen)

if ( DOXYGEN_FOUND )
set( DOXYGEN_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/doxygen )
# set( DOXYGEN_CREATE_SUBDIRS YES )
set( DOXYGEN_COLLABORATION_GRAPH YES )
set( DOXYGEN_EXTRACT_ALL YES )
set( DOXYGEN_CLASS_DIAGRAMS YES )
set( DOXYGEN_HIDE_UNDOC_RELATIONS NO )
set( DOXYGEN_HAVE_DOT YES )
set( DOXYGEN_CLASS_GRAPH YES )
set( DOXYGEN_CALL_GRAPH YES )
set( DOXYGEN_CALLER_GRAPH YES )
set( DOXYGEN_COLLABORATION_GRAPH YES )
set( DOXYGEN_BUILTIN_STL_SUPPORT YES )
set( DOXYGEN_EXTRACT_PRIVATE YES )
set( DOXYGEN_EXTRACT_PACKAGE YES )
set( DOXYGEN_EXTRACT_STATIC YES )
set( DOXYGEN_EXTRACT_LOCALMETHODS YES )
set( DOXYGEN_UML_LOOK YES )
set( DOXYGEN_UML_LIMIT_NUM_FIELDS 50 )
set( DOXYGEN_TEMPLATE_RELATIONS YES )
set( DOXYGEN_DOT_GRAPH_MAX_NODES 100 )
set( DOXYGEN_MAX_DOT_GRAPH_DEPTH 0 )
set( DOXYGEN_DOT_TRANSPARENT YES )
set( DOXYGEN_DOT_IMAGE_FORMAT svg )
set( DOXYGEN_INTERACTIVE_SVG YES )
set(DOXYGEN_DISABLE_INDEX NO)
set(DOXYGEN_FULL_SIDEBAR NO)
set(DOXYGEN_GENERATE_TREEVIEW YES)
set(DOXYGEN_HTML_EXTRA_STYLESHEET
"${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-awesome.css"
# "${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-custom/custom.css"
#"${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-awesome-sidebar-only.css"
#"${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css"
# "${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-custom/custom-alternative.css"
)
set(DOXYGEN_HTML_EXTRA_FILES
"${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js"
"${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js"
"${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-awesome-paragraph-link.js"
"${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-custom/toggle-alternative-theme.js"
"${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-awesome-interactive-toc.js"
"${CMAKE_SOURCE_DIR}/docs/doxygen-awesome-css/doxygen-awesome-tabs.js")
set(DOXYGEN_HTML_COLORSTYLE LIGHT)
doxygen_add_docs( doxygen ${CMAKE_SOURCE_DIR}/resolve )

else()
message( "Doxygen need to be installed to generate the doxygen documentation" )
endif()
Loading