docs: Use README.md as the Doxygen main page (see issue #3384)
Also set FULL_SIDEBAR=NO for consistency with older Doxygen versions where this option is not supported.
This commit is contained in:
parent
8645e88e0e
commit
09b4cbd32c
7
Doxyfile
7
Doxyfile
|
@ -908,7 +908,8 @@ WARN_LOGFILE =
|
|||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = include
|
||||
INPUT = README.md \
|
||||
include
|
||||
|
||||
# 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
|
||||
|
@ -1128,7 +1129,7 @@ FILTER_SOURCE_PATTERNS =
|
|||
# (index.html). This can be useful if you have a project on for instance GitHub
|
||||
# and want to reuse the introduction page also for the doxygen output.
|
||||
|
||||
USE_MDFILE_AS_MAINPAGE =
|
||||
USE_MDFILE_AS_MAINPAGE = README.md
|
||||
|
||||
# The Fortran standard specifies that for fixed formatted Fortran code all
|
||||
# characters from position 72 are to be considered as comment. A common
|
||||
|
@ -1701,7 +1702,7 @@ GENERATE_TREEVIEW = YES
|
|||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
FULL_SIDEBAR = YES
|
||||
FULL_SIDEBAR = NO
|
||||
|
||||
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
|
||||
# doxygen will group on one line in the generated HTML documentation.
|
||||
|
|
|
@ -9,8 +9,6 @@ The Chromium Embedded Framework (CEF) is a simple framework for embedding Chromi
|
|||
* Branches and Building - https://bitbucket.org/chromiumembedded/cef/wiki/BranchesAndBuilding
|
||||
* Announcements - https://groups.google.com/forum/#!forum/cef-announce
|
||||
* Support Forum - http://www.magpcss.org/ceforum/
|
||||
* CEF1 C++ API Docs - http://magpcss.org/ceforum/apidocs/
|
||||
* CEF3 C++ API Docs - http://magpcss.org/ceforum/apidocs3/
|
||||
* Downloads - https://cef-builds.spotifycdn.com/index.html
|
||||
* Donations - http://www.magpcss.org/ceforum/donate.php
|
||||
|
||||
|
|
|
@ -856,6 +856,10 @@ if mode == 'standard':
|
|||
# transfer Doxyfile
|
||||
transfer_doxyfile(output_dir, options.quiet)
|
||||
|
||||
# transfer README.md
|
||||
copy_file(os.path.join(cef_dir, 'README.md'), \
|
||||
os.path.join(output_dir, 'README.md'), options.quiet)
|
||||
|
||||
if not options.nodocs:
|
||||
# generate doc files
|
||||
sys.stdout.write("Generating docs...\n")
|
||||
|
|
Loading…
Reference in New Issue