frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 21:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

changed doxygen config to new docs path (#311)

Browse Source 
* updated ubuntu instructions

* updated ubuntu notes and troubleshooting

* updated tutorials using local files

* added doxygen python blocks for docs generation

* doxygen related files for generating docs

* removing Mac and Windows build status while those are in beta

* inference lookup is local now

* launch updates

* moved to docs folder, updating paths
This commit is contained in:
Aaron Markham
2017-04-19 11:49:59 -07:00
committed by GitHub
parent d58141ec4c
commit d47c1362c5
2 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
.Doxyfile-c
View File

@ -51,14 +51,14 @@ PROJECT_BRIEF = "A deep learning, cross platform ML framework"
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
PROJECT_LOGO = doxygen/Caffe2-with-name-55-tall.png
PROJECT_LOGO = docs/Caffe2-with-name-55-tall.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = doxygen/doxygen-c/
OUTPUT_DIRECTORY = docs/doxygen-c/
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
@ -703,7 +703,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE = doxygen/DoxygenLayout-c.xml
LAYOUT_FILE = docs/DoxygenLayout-c.xml
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
@ -863,7 +863,7 @@ EXCLUDE = build/ \
caffe2/test/ \
cmake/ \
models/ \
third_party/
third_party/
@ -1133,7 +1133,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 = doxygen/header.html
HTML_HEADER = docs/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
@ -1143,7 +1143,7 @@ HTML_HEADER = doxygen/header.html
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER = doxygen/footer.html
HTML_FOOTER = docs/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
@ -1155,7 +1155,7 @@ HTML_FOOTER = doxygen/footer.html
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET = doxygen/stylesheet.css
HTML_STYLESHEET = docs/stylesheet.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
@ -1168,7 +1168,7 @@ HTML_STYLESHEET = doxygen/stylesheet.css
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET = doxygen/main.css
HTML_EXTRA_STYLESHEET = docs/main.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

14
.Doxyfile-python
View File

@ -51,14 +51,14 @@ PROJECT_BRIEF = "A deep learning, cross platform ML framework"
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
PROJECT_LOGO = doxygen/Caffe2-with-name-55-tall.png
PROJECT_LOGO = docs/Caffe2-with-name-55-tall.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = doxygen/doxygen-python/
OUTPUT_DIRECTORY = docs/doxygen-python/
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
@ -703,7 +703,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.
LAYOUT_FILE = doxygen/DoxygenLayout-python.xml
LAYOUT_FILE = docs/DoxygenLayout-python.xml
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
@ -1114,7 +1114,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 = doxygen/header.html
HTML_HEADER = docs/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
@ -1124,7 +1124,7 @@ HTML_HEADER = doxygen/header.html
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER = doxygen/footer.html
HTML_FOOTER = docs/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
@ -1136,7 +1136,7 @@ HTML_FOOTER = doxygen/footer.html
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET = doxygen/stylesheet.css
HTML_STYLESHEET = docs/stylesheet.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
@ -1149,7 +1149,7 @@ HTML_STYLESHEET = doxygen/stylesheet.css
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET = doxygen/main.css
HTML_EXTRA_STYLESHEET = docs/main.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