diff --git a/makefiles/Makefile.doc.mk b/makefiles/Makefile.doc.mk index 427cdc2c51..3a6cb4b88d 100644 --- a/makefiles/Makefile.doc.mk +++ b/makefiles/Makefile.doc.mk @@ -1,17 +1,17 @@ # Generate documentation cpp-doc: - doxygen tools/cpp_graph.doxy - doxygen tools/cpp_linear.doxy - doxygen tools/cpp_routing.doxy - doxygen tools/cpp_sat.doxy + doxygen tools/doc/cpp_graph.doxy + doxygen tools/doc/cpp_linear.doxy + doxygen tools/doc/cpp_routing.doxy + doxygen tools/doc/cpp_sat.doxy dotnet-doc: - doxygen tools/dotnet.doxy + doxygen tools/doc/dotnet.doxy java-doc: - doxygen tools/java.doxy + doxygen tools/doc/java.doxy python-doc: - $(SET_PYTHONPATH) pdoc3 --html -o docs/python/ortools/sat/python/ ortools/sat/python/cp_model.py - $(SET_PYTHONPATH) pdoc3 --html -o docs/python/ortools/util/ ortools/gen/ortools/util/sorted_interval_list.py + $(SET_PYTHONPATH) pdoc3 --force --html -o docs/python/ortools/sat/python/ ortools/sat/python/cp_model.py + $(SET_PYTHONPATH) pdoc3 --html --force -o docs/python/ortools/util/ ortools/gen/ortools/util/sorted_interval_list.py diff --git a/tools/cpp_graph.doxy b/tools/doc/cpp_graph.doxy similarity index 99% rename from tools/cpp_graph.doxy rename to tools/doc/cpp_graph.doxy index b77d667dfa..f5c3146598 100644 --- a/tools/cpp_graph.doxy +++ b/tools/doc/cpp_graph.doxy @@ -922,7 +922,7 @@ IMAGE_PATH = # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. -INPUT_FILTER = "python3 tools/doxygen_filter.py" +INPUT_FILTER = "python3 tools/doc/doxygen_filter.py" # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the @@ -1113,7 +1113,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 = tools/ortools.header.html +HTML_HEADER = tools/doc/ortools.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 @@ -1123,7 +1123,7 @@ HTML_HEADER = tools/ortools.header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = tools/ortools.footer.html +HTML_FOOTER = tools/doc/ortools.footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1148,7 +1148,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = tools/ortools.css +HTML_EXTRA_STYLESHEET = tools/doc/ortools.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 diff --git a/tools/cpp_linear.doxy b/tools/doc/cpp_linear.doxy similarity index 99% rename from tools/cpp_linear.doxy rename to tools/doc/cpp_linear.doxy index cf4941dc09..54e3c04d79 100644 --- a/tools/cpp_linear.doxy +++ b/tools/doc/cpp_linear.doxy @@ -908,7 +908,7 @@ IMAGE_PATH = # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. -INPUT_FILTER = "python3 tools/doxygen_filter.py" +INPUT_FILTER = "python3 tools/doc/doxygen_filter.py" # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the @@ -1099,7 +1099,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 = tools/ortools.header.html +HTML_HEADER = tools/doc/ortools.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 @@ -1109,7 +1109,7 @@ HTML_HEADER = tools/ortools.header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = tools/ortools.footer.html +HTML_FOOTER = tools/doc/ortools.footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1134,7 +1134,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = tools/ortools.css +HTML_EXTRA_STYLESHEET = tools/doc/ortools.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 diff --git a/tools/cpp_routing.doxy b/tools/doc/cpp_routing.doxy similarity index 99% rename from tools/cpp_routing.doxy rename to tools/doc/cpp_routing.doxy index 99d208bc53..41d0f452e7 100644 --- a/tools/cpp_routing.doxy +++ b/tools/doc/cpp_routing.doxy @@ -914,7 +914,7 @@ IMAGE_PATH = # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. -INPUT_FILTER = "python3 tools/doxygen_filter.py" +INPUT_FILTER = "python3 tools/doc/doxygen_filter.py" # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the @@ -1105,7 +1105,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 = tools/ortools.header.html +HTML_HEADER = tools/doc/ortools.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 @@ -1115,7 +1115,7 @@ HTML_HEADER = tools/ortools.header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = tools/ortools.footer.html +HTML_FOOTER = tools/doc/ortools.footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1140,7 +1140,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = tools/ortools.css +HTML_EXTRA_STYLESHEET = tools/doc/ortools.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 diff --git a/tools/cpp_sat.doxy b/tools/doc/cpp_sat.doxy similarity index 99% rename from tools/cpp_sat.doxy rename to tools/doc/cpp_sat.doxy index 7f53fc18c5..d10b55825c 100644 --- a/tools/cpp_sat.doxy +++ b/tools/doc/cpp_sat.doxy @@ -909,7 +909,7 @@ IMAGE_PATH = # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. -INPUT_FILTER = "python3 tools/doxygen_filter.py" +INPUT_FILTER = "python3 tools/doc/doxygen_filter.py" # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the @@ -1100,7 +1100,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 = tools/ortools.header.html +HTML_HEADER = tools/doc/ortools.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 @@ -1110,7 +1110,7 @@ HTML_HEADER = tools/ortools.header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = tools/ortools.footer.html +HTML_FOOTER = tools/doc/ortools.footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1135,7 +1135,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = tools/ortools.css +HTML_EXTRA_STYLESHEET = tools/doc/ortools.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 diff --git a/tools/dotnet.doxy b/tools/doc/dotnet.doxy similarity index 99% rename from tools/dotnet.doxy rename to tools/doc/dotnet.doxy index 1ef2298d4f..da552e9d50 100644 --- a/tools/dotnet.doxy +++ b/tools/doc/dotnet.doxy @@ -1096,7 +1096,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 = tools/ortools.header.html +HTML_HEADER = tools/doc/ortools.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 @@ -1106,7 +1106,7 @@ HTML_HEADER = tools/ortools.header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = tools/ortools.footer.html +HTML_FOOTER = tools/doc/ortools.footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1118,7 +1118,7 @@ HTML_FOOTER = tools/ortools.footer.html # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_STYLESHEET = tools/ortools.css +HTML_STYLESHEET = tools/doc/ortools.css # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets @@ -1131,7 +1131,7 @@ HTML_STYLESHEET = tools/ortools.css # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = tools/ortools.css +HTML_EXTRA_STYLESHEET = tools/doc/ortools.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 diff --git a/tools/doxygen_filter.py b/tools/doc/doxygen_filter.py similarity index 100% rename from tools/doxygen_filter.py rename to tools/doc/doxygen_filter.py diff --git a/tools/java.doxy b/tools/doc/java.doxy similarity index 99% rename from tools/java.doxy rename to tools/doc/java.doxy index e8d458bab8..46b7a4a7cb 100644 --- a/tools/java.doxy +++ b/tools/doc/java.doxy @@ -1096,7 +1096,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 = tools/ortools.header.html +HTML_HEADER = tools/doc/ortools.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 @@ -1106,7 +1106,7 @@ HTML_HEADER = tools/ortools.header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = tools/ortools.footer.html +HTML_FOOTER = tools/doc/ortools.footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1118,7 +1118,7 @@ HTML_FOOTER = tools/ortools.footer.html # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_STYLESHEET = tools/ortools.css +HTML_STYLESHEET = tools/doc/ortools.css # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets @@ -1131,7 +1131,7 @@ HTML_STYLESHEET = tools/ortools.css # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = tools/ortools.css +HTML_EXTRA_STYLESHEET = tools/doc/ortools.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 diff --git a/tools/ortools.css b/tools/doc/ortools.css similarity index 100% rename from tools/ortools.css rename to tools/doc/ortools.css diff --git a/tools/ortools.footer.html b/tools/doc/ortools.footer.html similarity index 100% rename from tools/ortools.footer.html rename to tools/doc/ortools.footer.html diff --git a/tools/ortools.header.html b/tools/doc/ortools.header.html similarity index 100% rename from tools/ortools.header.html rename to tools/doc/ortools.header.html