forked from facebookresearch/habitat-sim
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Scaffolding for C++ docs (facebookresearch#185)
* Initial setup for C++ docs. * Set up crosslinking of Python and C++ docs. * Add at least some mainpage for C++ docs.
- Loading branch information
Showing
11 changed files
with
152,081 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
@INCLUDE = Doxyfile | ||
|
||
## Patches for the m.css-generated docs. Just need to generate XML, that's it. | ||
|
||
GENERATE_HTML = NO | ||
GENERATE_XML = YES | ||
XML_PROGRAMLISTING = NO | ||
|
||
# TODO: remove | ||
##! M_SHOW_UNDOCUMENTED = YES | ||
##! M_MAIN_PROJECT_URL = https://aihabitat.org/ | ||
|
||
##! M_CLASS_TREE_EXPAND_LEVELS = 2 | ||
|
||
##! M_LINKS_NAVBAR1 = \ | ||
##! "pages" \ | ||
##! "annotated" \ | ||
##! "files" | ||
##! M_LINKS_NAVBAR2 = \ | ||
##! "<a href="../habitat-sim/index.html">Python docs</a>" \ | ||
##! "<a href="https://aihabitat.org/habitat-api/">Python API</a>" | ||
|
||
ALIASES = \ | ||
"cb{1}=@code{\1}" \ | ||
"cpp=@code{.cpp}" \ | ||
"glsl=@code{.glsl}" \ | ||
"cmake=@code{.cmake}" \ | ||
"ce=@endcode" \ | ||
"m_div{1}=@xmlonly<mcss:div xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:class=\"\1\">@endxmlonly" \ | ||
"m_enddiv=@xmlonly</mcss:div>@endxmlonly" \ | ||
"m_span{1}=@xmlonly<mcss:span xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:class=\"\1\">@endxmlonly" \ | ||
"m_endspan=@xmlonly</mcss:span>@endxmlonly" \ | ||
"m_class{1}=@xmlonly<mcss:class xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:class=\"\1\" />@endxmlonly" \ | ||
"m_footernavigation=@xmlonly<mcss:footernavigation xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" />@endxmlonly" \ | ||
"m_examplenavigation{2}=@xmlonly<mcss:examplenavigation xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:page=\"\1\" mcss:prefix=\"\2\" />@endxmlonly" \ | ||
"m_keywords{1}=@xmlonly<mcss:search xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:keywords=\"\1\" />@endxmlonly" \ | ||
"m_keyword{3}=@xmlonly<mcss:search xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:keyword=\"\1\" mcss:title=\"\2\" mcss:suffix-length=\"\3\" />@endxmlonly" \ | ||
"m_enum_values_as_keywords=@xmlonly<mcss:search xmlns:mcss=\"http://mcss.mosra.cz/doxygen/\" mcss:enum-values-as-keywords=\"true\" />@endxmlonly" \ | ||
|
||
# kate: hl Doxyfile |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.