Skip to content

Commit

Permalink
Update documentation to gazebosim.org (gazebosim#248)
Browse files Browse the repository at this point in the history
Signed-off-by: Nate Koenig <[email protected]>

Co-authored-by: Nate Koenig <[email protected]>
  • Loading branch information
2 people authored and harshmahesheka committed May 24, 2022
1 parent e3c76dc commit 93c384f
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion cmake/ignition-config.cmake.in
Original file line number Diff line number Diff line change
Expand Up @@ -176,4 +176,4 @@ endforeach()
set(@PROJECT_NAME_NO_VERSION_UPPER@_DOXYGEN_TAGFILE "${PACKAGE_PREFIX_DIR}/@IGN_DATA_INSTALL_DIR@/@[email protected]")

# Specify the API url. This is where the doxygen tag file will resolve URLS to.
set(@PROJECT_NAME_NO_VERSION_UPPER@_API_URL "https://ignitionrobotics.org/api/@IGN_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@")
set(@PROJECT_NAME_NO_VERSION_UPPER@_API_URL "https://gazebosim.org/api/@IGN_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@")
4 changes: 2 additions & 2 deletions cmake/upload_doc.sh.in
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ if [ ! -f "@CMAKE_BINARY_DIR@/doxygen/html/index.html" ]; then
fi

# Dry run
s3cmd sync --dry-run @CMAKE_BINARY_DIR@/doxygen/html/ s3://ignitionrobotics.org/api/@IGN_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@/ -v
aws s3 sync --dryrun @CMAKE_BINARY_DIR@/doxygen/html/ s3://gazebosim.org/api/@IGN_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@/

if [ -z "$1" ]; then
echo -n "Upload (Y/n)? "
Expand All @@ -32,7 +32,7 @@ fi
if [ "$ans" = "n" ] || [ "$ans" = "N" ]; then
exit 1
else
s3cmd sync @CMAKE_BINARY_DIR@/doxygen/html/ s3://ignitionrobotics.org/api/@IGN_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@/ -v
aws s3 sync @CMAKE_BINARY_DIR@/doxygen/html/ s3://gazebosim.org/api/@IGN_DESIGNATION@/@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@/

echo "WARNING"
echo " A CloudFront invalidation is required. Run the following command with the appropriate \$CLOUDFRONT_DISTRIBUTION_ID:\n"
Expand Down
6 changes: 3 additions & 3 deletions doc/doxygen/api.in
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "Ignition @IGN_DESIGNATION_CAP@"
PROJECT_NAME = "Gazebo @IGN_DESIGNATION_CAP@"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down Expand Up @@ -768,7 +768,7 @@ WARN_FORMAT = "$file:$line: $text"
# messages should be written. If left blank the output is written to standard
# error (stderr).

WARN_LOGFILE = ignition-doxygen.warn
WARN_LOGFILE = gazebo-doxygen.warn

#---------------------------------------------------------------------------
# Configuration options related to the input files
Expand Down Expand Up @@ -1231,7 +1231,7 @@ GENERATE_DOCSET = NO
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.

DOCSET_FEEDNAME = "Ignition @IGN_DESIGNATION_CAP@ API Documentation"
DOCSET_FEEDNAME = "Gazebo @IGN_DESIGNATION_CAP@ API Documentation"

# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
Expand Down
12 changes: 6 additions & 6 deletions doc/doxygen/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@
<meta name="keywords" content="$projectname">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>$projectname: $title</title>
<script type="text/javascript" src="https://ignitionrobotics.org/assets/doxygen/dynsections.js"></script>
<script type="text/javascript" src="https://gazebosim.org/assets/doxygen/dynsections.js"></script>
<script type="text/javascript" src="jquery.js"></script>

<link rel="icon" type="image/x-icon" href="https://ignitionrobotics.org/assets/icon/favicon.ico">
<link rel="icon" type="image/x-icon" href="https://gazebosim.org/assets/icon/favicon.ico">
<link href='http://fonts.googleapis.com/css?family=Roboto:400,300,100,500,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="https://code.getmdl.io/1.3.0/material.deep_orange-blue.min.css">
<script defer src="https://code.getmdl.io/1.3.0/material.min.js"></script>

<script type="text/javascript" id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"> </script>

<link href="https://ignitionrobotics.org/assets/doxygen/doxygen.css" rel="stylesheet" type="text/css">
<link href="https://gazebosim.org/assets/doxygen/doxygen.css" rel="stylesheet" type="text/css">
</head>

<script type="text/javascript">
Expand All @@ -37,7 +37,7 @@
<div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer">
<div class="mdl-layout__drawer mdl-color--grey-100 mdl-color-text--blue-grey-50">
<header class="mdl-color--grey-100">
<a href="index.html"><img width="60px" src="https://ignitionrobotics.org/assets/doxygen/ignition_logo.svg"/></a>
<a href="index.html"><img width="60px" src="https://gazebosim.org/assets/doxygen/gazebo_logo.svg"/></a>
<h1 class="project_title">$projectname</h1>
<h2>API Reference</h2>
<div class="version">
Expand All @@ -62,9 +62,9 @@ <h2>API Reference</h2>
<i class="mdl-color-text--grey-400 material-icons"
role="presentation">insert_drive_file</i>Files</a>
<a class="mdl-navigation__link" target="_blank"
href="http://ignitionrobotics.org">
href="http://gazebosim.org">
<i class="mdl-color-text--grey-400 material-icons"
role="presentation">launch</i>Ignition Website</a>
role="presentation">launch</i>Gazebo Website</a>
</nav>

<!-- classes sub menu -->
Expand Down

0 comments on commit 93c384f

Please sign in to comment.