always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

make: Update doc integration

Browse Source
This commit is contained in:
Corentin Le Molgat
2020-01-31 15:21:03 +01:00
parent 206a72b7f8
commit ef704da21e
3 changed files with 38 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Makefile
View File

@@ -85,7 +85,13 @@ include $(OR_ROOT)makefiles/Makefile.python.mk
include $(OR_ROOT)makefiles/Makefile.java.mk
include $(OR_ROOT)makefiles/Makefile.dotnet.mk
include $(OR_ROOT)makefiles/Makefile.archive.mk
ifeq ($(SYSTEM),unix)
include $(OR_ROOT)makefiles/Makefile.doc.mk
else
Remove some rules on windows
help_doc:
endif
# Finally include user makefile if it exists
-include $(OR_ROOT)Makefile.user
@@ -106,7 +112,7 @@ else
endif
.PHONY: help_all
help_all: help_usage help_third_party help_cc help_python help_java help_dotnet help_archive
help_all: help_usage help_third_party help_cc help_python help_java help_dotnet help_archive help_doc
.PHONY: build_all
build_all: cc python java dotnet

16
makefiles/Makefile.doc.mk
View File

@@ -1,12 +1,24 @@
# 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
doxy-doc:
.PHONY: doxy-doc # Create doxygen ref documentation.
doxy-doc: cc python java dotnet
bash -c "command -v doxygen"
python3 tools/doc/gen_ref_doc.py
.PHONY: python-doc # Create python documentation.
python-doc:
$(SET_PYTHONPATH) pdoc3 --force --html --template-dir tools/doc/templates -o docs/python/ortools/sat/python/ ortools/sat/python/cp_model.py
bash -c "command -v pdoc3"
$(SET_PYTHONPATH) pdoc3 --html --force --template-dir tools/doc/templates -o docs/python/ortools/sat/python/ ortools/sat/python/cp_model.py
$(SET_PYTHONPATH) pdoc3 --html --force --template-dir tools/doc/templates -o docs/python/ortools/util/ ortools/gen/ortools/util/sorted_interval_list.py
$(SET_PYTHONPATH) pdoc3 --html --force --template-dir tools/doc/templates -o docs/python/ortools/linear_solver ortools/gen/ortools/linear_solver/pywraplp.py
$(SET_PYTHONPATH) pdoc3 --html --force --template-dir tools/doc/templates -o docs/python/ortools/constraint_solver ortools/gen/ortools/constraint_solver/pywrapcp.py

34
tools/doc/java.doxy.in
View File

@@ -791,23 +791,23 @@ WARN_LOGFILE =
# Note: If this tag is empty the current directory is searched.
INPUT = \
ortools/com/google/ortools/constraintsolver \
ortools/com/google/ortools/sat/Constraint.java \
ortools/com/google/ortools/sat/CpModel.java \
ortools/com/google/ortools/sat/CpSolver.java \
ortools/com/google/ortools/sat/CpSolverSolutionCallback.java \
ortools/com/google/ortools/sat/IntVar.java \
ortools/com/google/ortools/sat/IntervalVar.java \
ortools/com/google/ortools/sat/LinearExpr.java \
ortools/com/google/ortools/sat/Literal.java \
ortools/gen/com/google/ortools/algorithms \
ortools/gen/com/google/ortools/constraintsolver \
ortools/gen/com/google/ortools/graph \
ortools/gen/com/google/ortools/linearsolver \
ortools/gen/com/google/ortools/sat/CpModelProto.java \
ortools/gen/com/google/ortools/sat/SatParameters.java \
ortools/gen/com/google/ortools/sat/SatParametersOrBuilder.java \
ortools/gen/com/google/ortools/util
ortools/java/com/google/ortools/constraintsolver \
ortools/java/com/google/ortools/sat/Constraint.java \
ortools/java/com/google/ortools/sat/CpModel.java \
ortools/java/com/google/ortools/sat/CpSolver.java \
ortools/java/com/google/ortools/sat/CpSolverSolutionCallback.java \
ortools/java/com/google/ortools/sat/IntVar.java \
ortools/java/com/google/ortools/sat/IntervalVar.java \
ortools/java/com/google/ortools/sat/LinearExpr.java \
ortools/java/com/google/ortools/sat/Literal.java \
ortools/gen/java/com/google/ortools/algorithms \
ortools/gen/java/com/google/ortools/constraintsolver \
ortools/gen/java/com/google/ortools/graph \
ortools/gen/java/com/google/ortools/linearsolver \
ortools/gen/java/com/google/ortools/sat/CpModelProto.java \
ortools/gen/java/com/google/ortools/sat/SatParameters.java \
ortools/gen/java/com/google/ortools/sat/SatParametersOrBuilder.java \
ortools/gen/java/com/google/ortools/util
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses