Skip to content

Commit

Permalink
Add header meta to generated Doxygen pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@attipaci
attipaci committed Mar 2, 2024
1 parent 28f45a9 commit 8c7808f
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 13 deletions.
8 changes: 4 additions & 4 deletions Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1365,7 +1365,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_HEADER =
HTML_HEADER = resources/header.html

# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
Expand Down Expand Up @@ -1405,7 +1405,7 @@ HTML_STYLESHEET =
# documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET = css/doxygen_extra.css
HTML_EXTRA_STYLESHEET = resources/doxygen_extra.css

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand Down Expand Up @@ -1693,15 +1693,15 @@ QHG_LOCATION =
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.

GENERATE_ECLIPSEHELP = NO
GENERATE_ECLIPSEHELP = YES

# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.

ECLIPSE_DOC_ID = org.doxygen.Project
ECLIPSE_DOC_ID = edu.harvard.cfa.SuperNOVAS

# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
Expand Down
17 changes: 8 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ Earth (at the geocenter, on the surface, or in Earth orbit).
<a name="sidereal-example"></a>
### Calculating positions for a sidereal source

Sidereal sources may be anything beyond the solar-system with 'fixed' catalog coordinates. It may be a star, or a
A sidereal source may be anything beyond the solar-system with 'fixed' catalog coordinates. It may be a star, or a
galactic molecular cloud, or a distant quasar. First, you must provide the coordinates (which may include proper
motion and parallax). Let's assume we pick a star for which we have B1950 (i.e. FK4) coordinates:

Expand Down Expand Up @@ -374,13 +374,12 @@ distance (e.g. for apparent-to-physical size conversion):
```

The _placement_ of the celestial target in the observer's frame includes appropriate aberration corrections for the
observer's motion, as well as appropriate gravitational deflection corrections due to the Sun and Earth, and
for other major gravitating solar system bodies (in full precision mode; and if a planet provider function
is available).
observer's motion, as well as appropriate gravitational deflection corrections due to the Sun and Earth, and for other
major gravitating solar system bodies (in full precision mode and if a suitable planet provider function is available).

The calculated `sky_pos` structure contains all the information needed about the apparent position of the source
at the given date/time of observation. We may use it to get true apparent R.A. and declination from it, or to
calculate azimuth and elevation at the observing location. We'll consider these two cases separately below.
The calculated `sky_pos` structure contains all the information needed about the apparent position of the source at
the given date/time of observation. We may use it to get true apparent R.A. and declination from it, or to calculate
azimuth and elevation at the observing location. We'll consider these two cases separately below.


#### A. True apparent R.A. and declination
Expand Down Expand Up @@ -455,8 +454,8 @@ Solar-system sources work similarly to the above with a few important difference

First, You will have to provide one or more functions to obtain the barycentric ICRS positions for your Solar-system
source(s) of interest for the specific Barycentric Dynamical Time (TDB) of observation. See section on integrating
[External Solar-system ephemeris data or services](#solarsystem) with SuperNOVAS. You can specify the functions
that will handle the respective ephemeris data at runtime before making the NOVAS calls that need them, e.g.:
[External Solar-system ephemeris data or services](#solarsystem) with SuperNOVAS. You can specify the functions that
will handle the respective ephemeris data at runtime before making the NOVAS calls that need them, e.g.:

```c
// Set the function to use for regular precision planet position calculations
Expand Down
0 css/doxygen_extra.css → resources/doxygen_extra.css
View file
File renamed without changes.
90 changes: 90 additions & 0 deletions resources/header.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<!-- HTML header for doxygen 1.9.7-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-KLH8B274YR"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'G-KLH8B274YR');
</script>
<title>SuperNOVAS API Documnetation</title>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta charset="utf-8"/>
<meta name="description" content="NOVAS C astrometry library, made better. SuperNOVAS is an astronomy software library for the for the C programming language, providing high-precision astrometry such as one might need for running an observatory or a precise planetarium program. It is a fork of the Naval Observatory Vector Astrometry Software (NOVAS), with the aim of making it more user-friendly and easier to use overall."/>
<meta name="keywords" content="astronomy, astrometry, C, C++, library, NOVAS"/>
<meta name="author" content="Attila Kovacs"/>
<meta name="copyright" content="(C)2024 Attila Kovacs" />
<meta name="robots" content="index,follow"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN FULL_SIDEBAR-->
<script type="text/javascript">var page_layout=1;</script>
<!--END FULL_SIDEBAR-->
<!--END DISABLE_INDEX-->
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
$treeview
$search
$mathjax
$darkmode
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
</head>
<body>
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN FULL_SIDEBAR-->
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
<!--END FULL_SIDEBAR-->
<!--END DISABLE_INDEX-->

<div id="top"><!-- do not remove this div, it is closed by doxygen! -->

<!--BEGIN TITLEAREA-->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<!--BEGIN PROJECT_LOGO-->
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<td id="projectalign">
<div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
</div>
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
</td>
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<td>
<div id="projectbrief">$projectbrief</div>
</td>
<!--END PROJECT_BRIEF-->
<!--END !PROJECT_NAME-->
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
<!--BEGIN !FULL_SIDEBAR-->
<td>$searchbox</td>
<!--END !FULL_SIDEBAR-->
<!--END SEARCHENGINE-->
<!--END DISABLE_INDEX-->
</tr>
<!--BEGIN SEARCHENGINE-->
<!--BEGIN FULL_SIDEBAR-->
<tr><td colspan="2">$searchbox</td></tr>
<!--END FULL_SIDEBAR-->
<!--END SEARCHENGINE-->
</tbody>
</table>
</div>
<!--END TITLEAREA-->
<!-- end header part -->

0 comments on commit 8c7808f

Please sign in to comment.