Add Doxygen configuration and HTML resources for documentation genera…

…tion
Open-Cascade-SAS · Jan 21, 2025 · 9710dc9 · 9710dc9
1 parent 6e81313
commit 9710dc9
Show file tree

Hide file tree

Showing 8 changed files with 326 additions and 0 deletions.
diff --git a/dox/resources/index.html b/dox/resources/index.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+    <meta http-equiv="refresh" content="0;URL=html/index.html">
+  </head>
+  <body>
+  </body>
+</html>
diff --git a/dox/resources/occ_logo.png b/dox/resources/occ_logo.png
diff --git a/dox/resources/occt_logo.png b/dox/resources/occt_logo.png
diff --git a/dox/resources/occt_pdf_template.tex b/dox/resources/occt_pdf_template.tex
@@ -0,0 +1,151 @@
+\batchmode
+\nonstopmode
+\documentclass[oneside]{article}
+\n
+% Packages required by doxygen
+\usepackage{calc}
+\usepackage{doxygen}
+\usepackage{graphicx}
+\usepackage[utf8]{inputenc}
+\usepackage{makeidx}
+\usepackage{multicol}
+\usepackage{multirow}
+\usepackage{textcomp}
+\usepackage{amsmath}
+\usepackage[table]{xcolor}
+\usepackage{indentfirst}
+
+% Font selection
+\usepackage[T1]{fontenc}
+\usepackage{mathptmx}
+\usepackage[scaled=.90]{helvet}
+\usepackage{courier}
+\usepackage{amssymb}
+\usepackage{sectsty}
+\renewcommand{\familydefault}{\sfdefault}
+\allsectionsfont{%
+  \fontseries{bc}\selectfont%
+  \color{darkgray}%
+}
+\renewcommand{\DoxyLabelFont}{%
+  \fontseries{bc}\selectfont%
+  \color{darkgray}%
+}
+\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
+
+% Page & text layout
+\usepackage{geometry}
+\geometry{%
+  a4paper,%
+  top=2.5cm,%
+  bottom=2.5cm,%
+  left=2.5cm,%
+  right=2.5cm%
+}
+\tolerance=750
+\hfuzz=15pt
+\hbadness=750
+\setlength{\emergencystretch}{15pt}
+\setlength{\parindent}{0cm}
+\setlength{\parskip}{0.2cm}
+\makeatletter
+\renewcommand{\paragraph}{%
+  \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
+    \normalfont\normalsize\bfseries\SS@parafont%
+  }%
+}
+\renewcommand{\subparagraph}{%
+  \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
+    \normalfont\normalsize\bfseries\SS@subparafont%
+  }%
+}
+\makeatother
+
+% Headers & footers
+\usepackage{fancyhdr}
+\pagestyle{fancyplain}
+\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
+\fancyhead[CE]{\fancyplain{}{}}
+\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
+\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
+\fancyhead[CO]{\fancyplain{}{}}
+\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
+\fancyfoot[LE]{\fancyplain{}{}}
+\fancyfoot[CE]{\fancyplain{}{}}
+\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize (c) Open CASCADE DEFYEAR}}
+\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize (c) Open CASCADE DEFYEAR}}
+\fancyfoot[CO]{\fancyplain{}{}}
+\fancyfoot[RO]{\fancyplain{}{}}
+\renewcommand{\footrulewidth}{0.4pt}
+\renewcommand{\sectionmark}[1]{%
+  \markright{\thesection\ #1}%
+}
+
+% Indices & bibliography
+\usepackage{natbib}
+\usepackage[titles]{tocloft}
+\renewcommand{\cftsecleader}{\cftdotfill{\cftdotsep}}
+\setcounter{tocdepth}{3}
+\setcounter{secnumdepth}{5}
+\makeindex
+
+% Hyperlinks (required, but should be loaded last)
+\usepackage{ifpdf}
+\ifpdf
+  \usepackage[pdftex,pagebackref=true]{hyperref}
+\else
+  \usepackage[ps2pdf,pagebackref=true]{hyperref}
+\fi
+\hypersetup{%
+  colorlinks=true,%
+  linkcolor=blue,%
+  citecolor=black,%
+  urlcolor=blue,%
+  unicode%
+}
+
+% Custom commands
+\newcommand{\clearemptydoublepage}{%
+  \newpage{\pagestyle{empty}\cleardoublepage}%
+}
+
+
+%===== C O N T E N T S =====
+
+\begin{document}
+
+% Titlepage & ToC
+\hypersetup{pageanchor=false}
+\pagenumbering{roman}
+\begin{titlepage}
+\vspace*{7cm}
+\begin{center}%
+\includegraphics[width=0.75\textwidth, height=0.2\textheight]{../../../dox/resources/occt_logo.png}\\
+{\Large Open C\-A\-S\-C\-A\-D\-E Technology \\\\\Large DEFCASVERSION }\\
+\vspace*{1cm}
+{\Large DEFDOCLABEL}\\
+\vspace*{1cm}
+\vspace*{0.5cm}
+{\small \today}\
+\end{center}
+\end{titlepage}
+\clearpage
+\pagenumbering{roman}
+\newpage
+\pagenumbering{arabic}
+    \begingroup
+    \hypersetup{pageanchor=true, linkcolor=black, colorlinks=true}
+    \tableofcontents
+    \endgroup
+
+\let\stdsection\section
+  \renewcommand\section{\pagebreak\stdsection}
+\hypertarget{DEFFILENAME}{}
+\input{DEFFILENAME}
+
+% Index
+\newpage
+\phantomsection
+\addcontentsline{toc}{part}{Index}
+\printindex\n
+\end{document}
diff --git a/dox/resources/occt_rm.doxyfile b/dox/resources/occt_rm.doxyfile
@@ -0,0 +1,46 @@
+DOXYFILE_ENCODING      = UTF-8
+CREATE_SUBDIRS         = NO
+OUTPUT_LANGUAGE        = English
+MULTILINE_CPP_IS_BRIEF = YES
+INHERIT_DOCS           = YES
+REPEAT_BRIEF           = YES
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = NO
+OPTIMIZE_OUTPUT_FOR_C  = YES
+SUBGROUPING            = YES
+DISTRIBUTE_GROUP_DOC   = YES
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = NO
+EXTRACT_LOCAL_CLASSES  = NO
+EXTRACT_LOCAL_METHODS  = NO
+HIDE_FRIEND_COMPOUNDS  = YES
+HIDE_UNDOC_MEMBERS     = NO
+INLINE_INFO            = YES
+VERBATIM_HEADERS       = NO
+QUIET                  = YES
+WARNINGS               = NO
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = YES
+PREDEFINED             = Standard_EXPORT Standard_NODISCARD Standard_OVERRIDE:=override __Standard_API __Draw_API Handle(a):=Handle<a> DEFINE_STANDARD_ALLOC DEFINE_NCOLLECTION_ALLOC "Standard_DEPRECATED=//! @deprecated "
+GENERATE_HTML          = YES
+GENERATE_LATEX         = NO
+SEARCH_INCLUDES        = YES
+ALLEXTERNALS           = NO
+EXTERNAL_GROUPS        = NO
+COLLABORATION_GRAPH    = NO
+ENABLE_PREPROCESSING   = YES
+INCLUDE_FILE_PATTERNS  = *.hxx *.pxx
+EXCLUDE_PATTERNS       = */Handle_*.hxx
+SKIP_FUNCTION_MACROS   = YES
+INLINE_SOURCES         = NO
+HAVE_DOT               = YES
+DOT_GRAPH_MAX_NODES    = 100
+INCLUDE_GRAPH          = NO
+INCLUDED_BY_GRAPH      = NO
+DOT_MULTI_TARGETS      = YES
+DOT_IMAGE_FORMAT       = png
+GENERATE_LEGEND        = YES
+DOT_CLEANUP            = YES
+GRAPHICAL_HIERARCHY    = NO
diff --git a/dox/resources/occt_ug_html.doxyfile b/dox/resources/occt_ug_html.doxyfile
@@ -0,0 +1,59 @@
+DOXYFILE_ENCODING      = UTF-8
+PROJECT_NAME           = "Open CASCADE Technology"
+PROJECT_BRIEF          = 
+CREATE_SUBDIRS         = NO
+OUTPUT_LANGUAGE        = English
+ABBREVIATE_BRIEF       = 
+FULL_PATH_NAMES        = YES
+INHERIT_DOCS           = YES
+TAB_SIZE               = 4
+MARKDOWN_SUPPORT       = YES
+EXTRACT_ALL            = YES
+CASE_SENSE_NAMES       = NO
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = YES
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
+INPUT_ENCODING         = UTF-8
+FILE_PATTERNS          = *.md *.dox 
+RECURSIVE              = YES
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = YES
+GENERATE_DOCSET        = NO
+GENERATE_CHI           = NO
+GENERATE_QHP           = NO
+GENERATE_ECLIPSEHELP   = NO
+GENERATE_RTF           = NO
+GENERATE_MAN           = NO
+GENERATE_XML           = NO
+GENERATE_DOCBOOK       = NO
+GENERATE_AUTOGEN_DEF   = NO
+GENERATE_PERLMOD       = NO
+STRIP_CODE_COMMENTS    = NO
+GENERATE_LATEX         = NO
+GENERATE_HTMLHELP      = NO
+GENERATE_HTML          = YES
+HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_GAMMA  = 80
+HTML_TIMESTAMP         = YES
+HTML_DYNAMIC_SECTIONS  = YES
+HTML_INDEX_NUM_ENTRIES = 100
+DISABLE_INDEX          = YES
+GENERATE_TREEVIEW      = YES
+ENUM_VALUES_PER_LINE   = 8
+TREEVIEW_WIDTH         = 250
+EXTERNAL_PAGES         = NO
+SEARCHDATA_FILE        = searchdata.xml
+SKIP_FUNCTION_MACROS   = YES
+FORMULA_FONTSIZE       = 12
+FORMULA_TRANSPARENT    = YES
+USE_MATHJAX            = YES
+MATHJAX_FORMAT         = HTML-CSS
+
+# Define alias for inserting images in uniform way (both HTML and PDF)
+ALIASES += figure{1}="\image html \1"
+ALIASES += figure{2}="\image html \1 \2"
+ALIASES += figure{3}="\image html \1 \2"
diff --git a/dox/resources/occt_ug_pdf.doxyfile b/dox/resources/occt_ug_pdf.doxyfile
@@ -0,0 +1,52 @@
+DOXYFILE_ENCODING      = UTF-8
+PROJECT_NAME           = "Open CASCADE Technology"
+PROJECT_BRIEF          = 
+CREATE_SUBDIRS         = NO
+OUTPUT_LANGUAGE        = English
+ABBREVIATE_BRIEF       = 
+FULL_PATH_NAMES        = YES
+INHERIT_DOCS           = YES
+TAB_SIZE               = 4
+MARKDOWN_SUPPORT       = YES
+EXTRACT_ALL            = YES
+CASE_SENSE_NAMES       = NO
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = YES
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_NO_PARAMDOC       = NO
+INPUT_ENCODING         = UTF-8
+FILE_PATTERNS          = *.md *.dox 
+RECURSIVE              = YES
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = YES
+GENERATE_DOCSET        = NO
+GENERATE_CHI           = NO
+GENERATE_QHP           = NO
+GENERATE_ECLIPSEHELP   = NO
+GENERATE_RTF           = NO
+GENERATE_MAN           = NO
+GENERATE_XML           = NO
+GENERATE_DOCBOOK       = NO
+GENERATE_AUTOGEN_DEF   = NO
+GENERATE_PERLMOD       = NO
+STRIP_CODE_COMMENTS    = NO
+GENERATE_HTMLHELP      = NO
+GENERATE_HTML          = NO
+DISABLE_INDEX          = YES
+GENERATE_TREEVIEW      = NO
+PREDEFINED             = PDF_ONLY
+GENERATE_LATEX         = YES
+COMPACT_LATEX          = YES
+PDF_HYPERLINKS         = YES
+USE_PDFLATEX           = YES
+LATEX_BATCHMODE        = YES
+LATEX_OUTPUT           = latex
+LATEX_CMD_NAME         = latex
+MAKEINDEX_CMD_NAME     = makeindex
+
+# Define alias for inserting images in uniform way (both HTML and PDF)
+ALIASES += figure{1}="\image latex \1 \n"
+ALIASES += figure{2}="\image latex \1 \2 \n"
+ALIASES += figure{3}="\image latex \1 \2 width=\3 \n"
diff --git a/dox/resources/overview.html b/dox/resources/overview.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+    <meta http-equiv="refresh" content="0;URL=doc/overview/html/index.html">
+  </head>
+  <body>
+  </body>
+</html>