remove deprecated doc generation stuff
* remove "doc" target from legacy makefile based build * remove doxygen templates no more used * removed pdoc3 .mako files (we now re-use pdoc)
This commit is contained in:
Corentin Le Molgat
9
Makefile
9
Makefile
@@ -101,13 +101,6 @@ include $(OR_ROOT)makefiles/Makefile.dotnet.mk
|
||||
include $(OR_ROOT)makefiles/Makefile.java.mk
|
||||
include $(OR_ROOT)makefiles/Makefile.python.mk
|
||||
include $(OR_ROOT)makefiles/Makefile.archive.mk
|
||||
ifneq ($(PLATFORM),WIN64)
|
||||
include $(OR_ROOT)makefiles/Makefile.doc.mk
|
||||
else
|
||||
# Remove some rules on windows
|
||||
help_doc:
|
||||
|
||||
endif
|
||||
|
||||
.PHONY: help_usage
|
||||
help_usage:
|
||||
@@ -125,7 +118,7 @@ else
|
||||
endif
|
||||
|
||||
.PHONY: help_all
|
||||
help_all: help_usage help_cpp help_dotnet help_java help_python help_archive help_doc
|
||||
help_all: help_usage help_cpp help_dotnet help_java help_python help_archive
|
||||
|
||||
.PHONY: check_all
|
||||
check_all: check_cpp check_dotnet check_java check_python
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
# Copyright 2010-2025 Google LLC
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
# Generate documentation
|
||||
.PHONY: help_doc # Generate list of Documentation targets with descriptions.
|
||||
help_doc:
|
||||
@echo Use one of the following Documentation targets:
|
||||
@$(GREP) "^.PHONY: .* #" $(CURDIR)/makefiles/Makefile.doc.mk | $(SED) "s/\.PHONY: \(.*\) # \(.*\)/\1\t\2/" | expand -t20
|
||||
@echo
|
||||
|
||||
|
||||
# Main target
|
||||
.PHONY: doc # Create doxygen and python documentation.
|
||||
doc: doxy-doc python-doc java-doc
|
||||
|
||||
.PHONY: doxy-doc # Create doxygen ref documentation.
|
||||
doxy-doc: cpp python java dotnet
|
||||
bash -c "command -v doxygen"
|
||||
python3 tools/doc/gen_ref_doc.py
|
||||
|
||||
.PHONY: java-doc # Create Javadoc ref documentation.
|
||||
java-doc: java
|
||||
bash -c "command -v mvn"
|
||||
tools/doc/gen_javadoc.sh
|
||||
|
||||
.PHONY: python-doc # Create python documentation.
|
||||
python-doc: python
|
||||
bash -c "command -v pdoc"
|
||||
$(SET_PYTHONPATH) pdoc \
|
||||
--logo https://developers.google.com/optimization/images/orLogo.png \
|
||||
-o docs/python/ \
|
||||
--no-search -d google \
|
||||
--footer-text "OR-Tools ${OR_TOOLS_MAJOR}.${OR_TOOLS_MINOR}" \
|
||||
build_make/python/ortools
|
||||
@@ -1,220 +0,0 @@
|
||||
<doxygenlayout version="1.0">
|
||||
<!-- Generated by doxygen 1.8.15 -->
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="no" title=""/>
|
||||
<tab type="pages" visible="no" title="" intro=""/>
|
||||
<tab type="modules" visible="yes" title="" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespacelist" visible="no" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="no" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="interfaces" visible="no" title="">
|
||||
<tab type="interfacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="classes" visible="yes" title="">
|
||||
<tab type="classlist" visible="no" title="" intro=""/>
|
||||
<tab type="classindex" visible="no" title=""/>
|
||||
<tab type="hierarchy" visible="no" title="" intro=""/>
|
||||
<tab type="classmembers" visible="no" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="structs" visible="no" title="">
|
||||
<tab type="structlist" visible="yes" title="" intro=""/>
|
||||
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
</tab>
|
||||
<tab type="exceptions" visible="no" title="">
|
||||
<tab type="exceptionlist" visible="yes" title="" intro=""/>
|
||||
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="files" visible="yes" title="">
|
||||
<tab type="filelist" visible="no" title="" intro=""/>
|
||||
<tab type="globals" visible="no" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="examples" visible="yes" title="" intro=""/>
|
||||
</navindex>
|
||||
|
||||
<!-- Layout definition for a class page -->
|
||||
<class>
|
||||
<detaileddescription title=""/>
|
||||
<includes visible="no"/>
|
||||
<inheritancegraph visible="no"/>
|
||||
<collaborationgraph visible="no"/>
|
||||
<memberdecl>
|
||||
<nestedclasses visible="yes" title=""/>
|
||||
<publictypes title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<publicslots title=""/>
|
||||
<signals title=""/>
|
||||
<publicmethods title=""/>
|
||||
<publicstaticmethods title=""/>
|
||||
<publicattributes title=""/>
|
||||
<publicstaticattributes title=""/>
|
||||
<protectedtypes title=""/>
|
||||
<protectedslots title=""/>
|
||||
<protectedmethods title=""/>
|
||||
<protectedstaticmethods title=""/>
|
||||
<protectedattributes title=""/>
|
||||
<protectedstaticattributes title=""/>
|
||||
<packagetypes title=""/>
|
||||
<packagemethods title=""/>
|
||||
<packagestaticmethods title=""/>
|
||||
<packageattributes title=""/>
|
||||
<packagestaticattributes title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
<privatetypes title=""/>
|
||||
<privateslots title=""/>
|
||||
<privatemethods title=""/>
|
||||
<privatestaticmethods title=""/>
|
||||
<privateattributes title=""/>
|
||||
<privatestaticattributes title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<constructors title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
</memberdef>
|
||||
<allmemberslink visible="yes"/>
|
||||
<usedfiles visible="$SHOW_USED_FILES"/>
|
||||
<authorsection visible="no"/>
|
||||
</class>
|
||||
|
||||
<!-- Layout definition for a namespace page -->
|
||||
<namespace>
|
||||
<briefdescription visible="yes"/>
|
||||
<memberdecl>
|
||||
<nestednamespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<interfaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<structs visible="yes" title=""/>
|
||||
<exceptions visible="yes" title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</namespace>
|
||||
|
||||
<!-- Layout definition for a file page -->
|
||||
<file>
|
||||
<briefdescription visible="no"/>
|
||||
<detaileddescription title=""/>
|
||||
<includes visible="no"/>
|
||||
<includegraph visible="no"/>
|
||||
<includedbygraph visible="no"/>
|
||||
<sourcelink visible="yes"/>
|
||||
<memberdecl>
|
||||
<interfaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<structs visible="yes" title=""/>
|
||||
<exceptions visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection/>
|
||||
</file>
|
||||
|
||||
<!-- Layout definition for a group page -->
|
||||
<group>
|
||||
<briefdescription visible="yes"/>
|
||||
<groupgraph visible="$GROUP_GRAPHS"/>
|
||||
<memberdecl>
|
||||
<nestedgroups visible="yes" title=""/>
|
||||
<dirs visible="yes" title=""/>
|
||||
<files visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<pagedocs/>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<sequences title=""/>
|
||||
<dictionaries title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</group>
|
||||
|
||||
<!-- Layout definition for a directory page -->
|
||||
<directory>
|
||||
<briefdescription visible="yes"/>
|
||||
<directorygraph visible="yes"/>
|
||||
<memberdecl>
|
||||
<dirs visible="yes"/>
|
||||
<files visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
</directory>
|
||||
</doxygenlayout>
|
||||
@@ -1,8 +0,0 @@
|
||||
</div>
|
||||
</div>
|
||||
<div id="footer-container">
|
||||
<div id="footer">
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,33 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>OR-Tools</title>
|
||||
<meta http-equiv="Content-Type" content="text/html;"/>
|
||||
<meta charset="utf-8"/>
|
||||
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
$extrastylesheet
|
||||
</head>
|
||||
<body>
|
||||
<div id="banner-container">
|
||||
<div id="banner">
|
||||
<span id="sfml">Banner Text</span>
|
||||
</div>
|
||||
</div>
|
||||
<div id="content" style="width: 100%; overflow: hidden;">
|
||||
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
|
||||
<h2>C++ Reference</h2>
|
||||
<ul>
|
||||
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
|
||||
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
|
||||
<li><a href="../cpp_graph/annotated.html">Graph</a></li>
|
||||
<li><a href="../cpp_routing/annotated.html">Routing</a></li>
|
||||
<li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="content">
|
||||
<div align="center">
|
||||
<h1 style="color: #145A32;">Page Title</h1>
|
||||
</div>
|
||||
@@ -1,21 +0,0 @@
|
||||
<!-- HTML footer for doxygen 1.8.18-->
|
||||
<!-- start footer part -->
|
||||
<!--BEGIN GENERATE_TREEVIEW-->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
$navpath
|
||||
<li class="footer">$generatedby
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--END GENERATE_TREEVIEW-->
|
||||
<!--BEGIN !GENERATE_TREEVIEW-->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
$generatedby  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
|
||||
</a> $doxygenversion
|
||||
</small></address>
|
||||
<!--END !GENERATE_TREEVIEW-->
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,56 +0,0 @@
|
||||
<!-- HTML header for doxygen 1.8.18-->
|
||||
<!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">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<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"/>
|
||||
<script type="text/javascript" src="$relpath^jquery.js"></script>
|
||||
<script type="text/javascript" src="$relpath^dynsections.js"></script>
|
||||
$treeview
|
||||
$search
|
||||
$mathjax
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
$extrastylesheet
|
||||
</head>
|
||||
<body>
|
||||
<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 style="height: 56px;">
|
||||
<!--BEGIN PROJECT_LOGO-->
|
||||
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
|
||||
<!--END PROJECT_LOGO-->
|
||||
<!--BEGIN PROJECT_NAME-->
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">$projectname
|
||||
<!--BEGIN PROJECT_NUMBER--> <span id="projectnumber">$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 style="padding-left: 0.5em;">
|
||||
<div id="projectbrief">$projectbrief</div>
|
||||
</td>
|
||||
<!--END PROJECT_BRIEF-->
|
||||
<!--END !PROJECT_NAME-->
|
||||
<!--BEGIN DISABLE_INDEX-->
|
||||
<!--BEGIN SEARCHENGINE-->
|
||||
<td>$searchbox</td>
|
||||
<!--END SEARCHENGINE-->
|
||||
<!--END DISABLE_INDEX-->
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!--END TITLEAREA-->
|
||||
<!-- end header part -->
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -1,34 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>OR-Tools</title>
|
||||
<meta http-equiv="Content-Type" content="text/html;"/>
|
||||
<meta charset="utf-8"/>
|
||||
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
$extrastylesheet
|
||||
</head>
|
||||
<body>
|
||||
<div id="banner-container">
|
||||
<div id="banner">
|
||||
<span id="sfml">Banner Text</span>
|
||||
</div>
|
||||
</div>
|
||||
<div id="content" style="width: 100%; overflow: hidden;">
|
||||
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
|
||||
<h2>DotNet Reference</h2>
|
||||
<ul>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Sat.html">CP-SAT</a></li>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Graph.html">Graph</a></li>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Algorithms.html">Knapsack solver</a></li>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1LinearSolver.html">Linear solver</a></li>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1ConstraintSolver.html">Routing</a></li>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Util.html">Util</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="content">
|
||||
<div align="center">
|
||||
<h1 style="color: #145A32;">Page Title</h1>
|
||||
</div>
|
||||
@@ -1,27 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
# Copyright 2010-2025 Google LLC
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
set -euxo pipefail
|
||||
|
||||
# Check tar is in PATH
|
||||
command -v jar
|
||||
|
||||
source Version.txt
|
||||
|
||||
OUTPUT_DIR="docs/javadoc"
|
||||
rm -rf ${OUTPUT_DIR}
|
||||
mkdir -p ${OUTPUT_DIR}
|
||||
|
||||
ARCHIVE=$(find "build_make/java/ortools-java/target" -iname "ortools-java-${OR_TOOLS_MAJOR}.${OR_TOOLS_MINOR}.*-javadoc.jar")
|
||||
(cd ${OUTPUT_DIR} && jar -xvf "../../${ARCHIVE}")
|
||||
@@ -1,266 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
# Copyright 2010-2025 Google LLC
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
"""Generate OR-Tools ref doc using Doxygen."""
|
||||
import os
|
||||
import re
|
||||
|
||||
|
||||
def main(version):
|
||||
"""For each doc section, edit the doxy and header files, and generate the doc."""
|
||||
sections = create_section_data()
|
||||
doxy_tmp = 'tools/doc/tmp.doxy'
|
||||
header_tmp = 'tools/doc/header.tmp.html'
|
||||
footer_tmp = 'tools/doc/footer.tmp.html'
|
||||
style_sheet_tmp = 'tools/doc/styleSheet.tmp.css'
|
||||
|
||||
for section in sections:
|
||||
output_dir = section['output_dir']
|
||||
project_name = section['project name']
|
||||
title = section['title']
|
||||
doxyfile = 'tools/doc/' + section['doxyfile']
|
||||
headerfile = 'tools/doc/' + section['headerfile']
|
||||
footerfile = 'tools/doc/' + section['footerfile']
|
||||
stylesheetfile = 'tools/doc/' + section['styleSheetfile']
|
||||
input_files = section['input_files']
|
||||
# Edit doxyfile.
|
||||
project_name_string = 'PROJECT_NAME = ' + project_name
|
||||
project_number_string = 'PROJECT_NUMBER = ' + version
|
||||
html_output_string = 'HTML_OUTPUT = ' + output_dir
|
||||
input_string = 'INPUT = ' + input_files
|
||||
f = open(doxyfile, 'r')
|
||||
g = open(doxy_tmp, 'w')
|
||||
filedata = f.read()
|
||||
filedata = re.sub('PROJECT_NAME', project_name_string, filedata)
|
||||
filedata = re.sub('PROJECT_NUMBER', project_number_string, filedata)
|
||||
filedata = re.sub('HTML_OUTPUT', html_output_string, filedata)
|
||||
if input_files:
|
||||
filedata = re.sub(r'INPUT.*=.*', input_string, filedata)
|
||||
# Write filedata.
|
||||
g.write(filedata)
|
||||
f.close()
|
||||
g.close()
|
||||
|
||||
# Edit header file.
|
||||
f = open(headerfile, 'r')
|
||||
g = open(header_tmp, 'w')
|
||||
filedata = f.read()
|
||||
filedata = re.sub('Banner Text', 'Google OR-Tools ' + version,
|
||||
filedata)
|
||||
filedata = re.sub('Page Title', title, filedata)
|
||||
# Write filedata.
|
||||
g.write(filedata)
|
||||
f.close()
|
||||
g.close()
|
||||
|
||||
# Edit footer file.
|
||||
f = open(footerfile, 'r')
|
||||
g = open(footer_tmp, 'w')
|
||||
filedata = f.read()
|
||||
# Write filedata.
|
||||
g.write(filedata)
|
||||
f.close()
|
||||
g.close()
|
||||
|
||||
# Edit style sheet file.
|
||||
f = open(stylesheetfile, 'r')
|
||||
g = open(style_sheet_tmp, 'w')
|
||||
filedata = f.read()
|
||||
# Write filedata.
|
||||
g.write(filedata)
|
||||
f.close()
|
||||
g.close()
|
||||
|
||||
# Clean previous doc.
|
||||
os.system('rm -rf docs/' + output_dir)
|
||||
# Generate the doc.
|
||||
os.system(f'doxygen {doxy_tmp}')
|
||||
# Remove temp files.
|
||||
os.system(f'rm {doxy_tmp}')
|
||||
os.system(f'rm {header_tmp}')
|
||||
os.system(f'rm {footer_tmp}')
|
||||
os.system(f'rm {style_sheet_tmp}')
|
||||
|
||||
|
||||
def create_section_data():
|
||||
"""Generate each section configuration."""
|
||||
sections = [{
|
||||
'output_dir':
|
||||
'cpp_algorithms',
|
||||
'project name':
|
||||
'Algorithms',
|
||||
'title':
|
||||
'C++ Reference: Algorithms',
|
||||
'doxyfile':
|
||||
'cpp.doxy.in',
|
||||
'headerfile':
|
||||
'cpp.header.html.in',
|
||||
'footerfile':
|
||||
'all.footer.html.in',
|
||||
'styleSheetfile':
|
||||
'all.styleSheet.css.in',
|
||||
'input_files':
|
||||
'ortools/algorithms/dense_doubly_linked_list.h ' +
|
||||
'ortools/algorithms/dynamic_partition.h ' +
|
||||
'ortools/algorithms/dynamic_permutation.h ' +
|
||||
'ortools/algorithms/find_graph_symmetries.h ' +
|
||||
'ortools/algorithms/hungarian.h ' +
|
||||
'ortools/algorithms/knapsack_solver.h ' +
|
||||
'ortools/algorithms/sparse_permutation.h'
|
||||
}, {
|
||||
'output_dir':
|
||||
'cpp_sat',
|
||||
'project name':
|
||||
'CP-SAT',
|
||||
'title':
|
||||
'C++ Reference: CP-SAT',
|
||||
'doxyfile':
|
||||
'cpp.doxy.in',
|
||||
'headerfile':
|
||||
'cpp.header.html.in',
|
||||
'footerfile':
|
||||
'all.footer.html.in',
|
||||
'styleSheetfile':
|
||||
'all.styleSheet.css.in',
|
||||
'input_files':
|
||||
'ortools/sat/cp_model.h ' + 'ortools/sat/cp_model_solver.h ' +
|
||||
'ortools/sat/model.h ' + 'ortools/util/sorted_interval_list.h ' +
|
||||
'ortools/util/time_limit.h ' +
|
||||
'ortools/gen/ortools/sat/boolean_problem.pb.h ' +
|
||||
'ortools/gen/ortools/sat/cp_model.pb.h ' +
|
||||
'ortools/gen/ortools/sat/sat_parameters.pb.h'
|
||||
}, {
|
||||
'output_dir':
|
||||
'cpp_graph',
|
||||
'project name':
|
||||
'Graph',
|
||||
'title':
|
||||
'C++ Reference: Graph',
|
||||
'doxyfile':
|
||||
'cpp.doxy.in',
|
||||
'headerfile':
|
||||
'cpp.header.html.in',
|
||||
'footerfile':
|
||||
'all.footer.html.in',
|
||||
'styleSheetfile':
|
||||
'all.styleSheet.css.in',
|
||||
'input_files':
|
||||
'ortools/graph/christofides.h ' + 'ortools/graph/cliques.h ' +
|
||||
'ortools/graph/connected_components.h ' +
|
||||
'ortools/graph/connectivity.h ' +
|
||||
'ortools/graph/eulerian_path.h ' + 'ortools/graph/graph.h ' +
|
||||
'ortools/graph/graphs.h ' + 'ortools/graph/hamiltonian_path.h ' +
|
||||
'ortools/graph/graph_io.h ' + 'ortools/graph/iterators.h ' +
|
||||
'ortools/graph/linear_assignment.h ' + 'ortools/graph/max_flow.h ' +
|
||||
'ortools/graph/min_cost_flow.h ' +
|
||||
'ortools/graph/minimum_spanning_tree.h ' +
|
||||
'ortools/graph/one_tree_lower_bound.h ' +
|
||||
'ortools/graph/shortestpaths.h ' +
|
||||
'ortools/graph/strongly_connected_components.h ' +
|
||||
'ortools/graph/util.h ' +
|
||||
'ortools/gen/ortools/graph/flow_problem.pb.h '
|
||||
}, {
|
||||
'output_dir':
|
||||
'cpp_linear',
|
||||
'project name':
|
||||
'Linear solver',
|
||||
'title':
|
||||
'C++ Reference: Linear solver',
|
||||
'doxyfile':
|
||||
'cpp.doxy.in',
|
||||
'headerfile':
|
||||
'cpp.header.html.in',
|
||||
'footerfile':
|
||||
'all.footer.html.in',
|
||||
'styleSheetfile':
|
||||
'all.styleSheet.css.in',
|
||||
'input_files':
|
||||
'ortools/linear_solver/linear_expr.h ' +
|
||||
'ortools/linear_solver/linear_solver.h ' +
|
||||
'ortools/linear_solver/model_exporter.h ' +
|
||||
'ortools/linear_solver/model_exporter_swig_helper.h ' +
|
||||
'ortools/linear_solver/model_validator.h ' +
|
||||
'ortools/gen/ortools/linear_solver/linear_solver.pb.h '
|
||||
}, {
|
||||
'output_dir':
|
||||
'cpp_routing',
|
||||
'project name':
|
||||
'Routing',
|
||||
'title':
|
||||
'C++ Reference: Routing',
|
||||
'doxyfile':
|
||||
'cpp.doxy.in',
|
||||
'headerfile':
|
||||
'cpp.header.html.in',
|
||||
'footerfile':
|
||||
'all.footer.html.in',
|
||||
'styleSheetfile':
|
||||
'all.styleSheet.css.in',
|
||||
'input_files':
|
||||
'ortools/constraint_solver/constraint_solver.h ' +
|
||||
'ortools/constraint_solver/constraint_solveri.h ' +
|
||||
'ortools/constraint_solver/routing.h ' +
|
||||
'ortools/constraint_solver/routing_index_manager.h ' +
|
||||
'ortools/constraint_solver/routing_lp_scheduling.h ' +
|
||||
'ortools/constraint_solver/routing_neighborhoods.h ' +
|
||||
'ortools/constraint_solver/routing_parameters.h ' +
|
||||
'ortools/constraint_solver/routing_types.h ' +
|
||||
'ortools/gen/ortools/constraint_solver/assignment.pb.h ' +
|
||||
'ortools/gen/ortools/constraint_solver/demon_profiler.pb.h ' +
|
||||
'ortools/gen/ortools/constraint_solver/routing_enums.pb.h ' +
|
||||
'ortools/gen/ortools/constraint_solver/routing_parameters.pb.h ' +
|
||||
'ortools/gen/ortools/constraint_solver/search_limit.pb.h ' +
|
||||
'ortools/gen/ortools/constraint_solver/solver_parameters.pb.h '
|
||||
}, {
|
||||
'output_dir': 'cpp',
|
||||
'project name': 'OR-Tools',
|
||||
'title': 'C++ Reference',
|
||||
'doxyfile': 'cpp.doxy.in',
|
||||
'headerfile': 'default.header.html.in',
|
||||
'footerfile': 'default.footer.html.in',
|
||||
'styleSheetfile': 'default.styleSheet.css.in',
|
||||
'input_files': 'ortools ' + 'tools/doc'
|
||||
}, {
|
||||
'output_dir': 'dotnet',
|
||||
'project name': 'OR-Tools',
|
||||
'title': '.Net Reference',
|
||||
'doxyfile': 'dotnet.doxy.in',
|
||||
'headerfile': 'dotnet.header.html.in',
|
||||
'footerfile': 'all.footer.html.in',
|
||||
'styleSheetfile': 'all.styleSheet.css.in',
|
||||
'input_files': 'ortools ' + 'tools/doc'
|
||||
}, {
|
||||
'output_dir': 'java',
|
||||
'project name': 'OR-Tools',
|
||||
'title': 'Java Reference',
|
||||
'doxyfile': 'java.doxy.in',
|
||||
'headerfile': 'java.header.html.in',
|
||||
'footerfile': 'all.footer.html.in',
|
||||
'styleSheetfile': 'all.styleSheet.css.in',
|
||||
'input_files': 'ortools ' + 'tools/doc'
|
||||
}]
|
||||
return sections
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
version_file = open('Version.txt', 'r')
|
||||
version_file_data = version_file.read()
|
||||
version_file.close()
|
||||
major_pattern = re.compile(r'OR_TOOLS_MAJOR=(\d)')
|
||||
minor_pattern = re.compile(r'OR_TOOLS_MINOR=(\d)')
|
||||
major = major_pattern.findall(version_file_data)[0]
|
||||
minor = minor_pattern.findall(version_file_data)[0]
|
||||
|
||||
version_number = f'{major}.{minor}'
|
||||
main(version_number)
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,34 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>OR-Tools</title>
|
||||
<meta http-equiv="Content-Type" content="text/html;"/>
|
||||
<meta charset="utf-8"/>
|
||||
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
$extrastylesheet
|
||||
</head>
|
||||
<body>
|
||||
<div id="banner-container">
|
||||
<div id="banner">
|
||||
<span id="sfml">Banner Text</span>
|
||||
</div>
|
||||
</div>
|
||||
<div id="content" style="width: 100%; overflow: hidden;">
|
||||
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
|
||||
<h2>Java Reference</h2>
|
||||
<ul>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1sat.html">CP-SAT</a></li>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1graph.html">Graph</a></li>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1algorithms.html">Knapsack solver</a></li>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1linearsolver.html">Linear solver</a></li>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1constraintsolver.html">Routing</a></li>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1util.html">Util</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="content">
|
||||
<div align="center">
|
||||
<h1 style="color: #145A32;">Page Title</h1>
|
||||
</div>
|
||||
@@ -1,67 +0,0 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>OR-Tools</title>
|
||||
<meta http-equiv="Content-Type" content="text/html;"/>
|
||||
<meta charset="utf-8"/>
|
||||
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
|
||||
<link rel="stylesheet" type="text/css" href="ortools.css" title="default" media="screen,print" />
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="banner-container">
|
||||
<div id="banner">
|
||||
<span id="sfml">Banner Text</span>
|
||||
</div>
|
||||
</div>
|
||||
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
|
||||
<div id="content" style="width: 100%; overflow: hidden;">
|
||||
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
|
||||
<h2>Reference</h2>
|
||||
|
||||
<h3>C++</h3>
|
||||
<ul>
|
||||
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
|
||||
<li><a href="../cpp_graph/annotated.html">Graph</a></li>
|
||||
<li><a href="../cpp_routing/annotated.html">Routing</a></li>
|
||||
<li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
|
||||
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
|
||||
</ul>
|
||||
|
||||
<h3>Python</h3>
|
||||
<ul>
|
||||
<li><a href="../python/ortools/sat/python/cp_model.html">CP-SAT</a></li>
|
||||
<li><a href="../python/ortools/util/sorted_interval_list.html">Domain</a></li>
|
||||
<li><a href="../python/ortools/graph/pywrapgraph.html">Graph</a></li>
|
||||
<li><a href="../python/ortools/algorithms/pywrapknapsack_solver.html">Knapsack solver</a></li>
|
||||
<li><a href="../python/ortools/linear_solver/pywraplp.html">Linear solver</a></li>
|
||||
<li><a href="../python/ortools/constraint_solver/pywrapcp.html">Routing</a></li>
|
||||
</ul>
|
||||
|
||||
<h3 id="dotnet-documentation">DotNET</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Sat.html">CP-SAT</a></li>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Graph.html">Graph</a></li>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Algorithms.html">Knapsack solver</a></li>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1LinearSolver.html">Linear solver</a></li>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1ConstraintSolver.html">Routing</a></li>
|
||||
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Util.html">Util</a></li>
|
||||
</ul>
|
||||
|
||||
<h3 id="java-documentation">Java Documentation</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1sat.html">CP-SAT</a></li>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1graph.html">Graph</a></li>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1algorithms.html">Knapsack solver</a></li>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1linearsolver.html">Linear solver</a></li>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1constraintsolver.html">Routing</a></li>
|
||||
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1util.html">Util</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="content">
|
||||
<div align="center">
|
||||
<h1 style="color: #145A32;">Page Title</h1>
|
||||
</div>
|
||||
@@ -1,19 +0,0 @@
|
||||
/*! @file
|
||||
@author Mizux <mizux.dev@gmail.com>
|
||||
*/
|
||||
|
||||
/*! @mainpage Introduction
|
||||
Google's software suite for combinatorial optimization.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@namespace operations_research
|
||||
Meta namespace.
|
||||
*/
|
||||
|
||||
/*!
|
||||
List of constraint solver samples:
|
||||
@example nurses_cp.cc
|
||||
@example tsp.cc
|
||||
@example vrp.cc
|
||||
*/
|
||||
0
tools/doc/templates/credits.mako
vendored
0
tools/doc/templates/credits.mako
vendored
6
tools/doc/templates/head.mako
vendored
6
tools/doc/templates/head.mako
vendored
@@ -1,6 +0,0 @@
|
||||
<style type="text/css">
|
||||
a:link { color: #46641e; text-decoration: none}
|
||||
.ident { color: #46641e }
|
||||
</style>
|
||||
|
||||
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
|
||||
5
tools/doc/templates/logo.mako
vendored
5
tools/doc/templates/logo.mako
vendored
@@ -1,5 +0,0 @@
|
||||
<header>
|
||||
<a class="homelink" rel="home" title="OR-Tools Home" href="https://google.github.io/or-tools/">
|
||||
<img src="https://developers.google.com/optimization/images/orLogo.png" alt=""> OR-Tools
|
||||
</a>
|
||||
</header>
|
||||
Reference in New Issue
Block a user