caio/clang-p2996
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[BOLT][DOCS] Link to README instead of the github page in Doxygen

Browse Source 
Summary:
Link to the README page built with the rest of the documentation,
a future-proof solution.

(cherry picked from FBD33357870)
This commit is contained in:
Amir Ayupov
2021-12-29 17:38:06 -08:00
committed by Maksim Panchenko
parent 513bbd3f36
commit ccc4d4397f
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
bolt/docs/doxygen-mainpage.dox
View File

@@ -6,8 +6,8 @@
/// This documentation describes the **internal** software that makes
/// up BOLT, not the **external** use of BOLT. There are no instructions
/// here on how to use BOLT, only the APIs that make up the software. For
/// usage instructions, please see the [project website](https://github.com/facebookincubator/BOLT/tree/main/bolt)
/// for further detail.
/// usage instructions, please see the [README](@ref md_README) for further
/// detail.
///
/// \section main_caveat Caveat
/// This documentation is generated directly from the source code with doxygen.

2
bolt/docs/doxygen.cfg.in
View File

@@ -748,6 +748,8 @@ WARN_LOGFILE =
INPUT = @abs_top_srcdir@/../include/ \
@abs_top_srcdir@/../lib/ \
@abs_top_srcdir@/../runtime/ \
@abs_top_srcdir@/../tools/ \
@abs_top_srcdir@/../README.md \
@abs_top_srcdir@/doxygen-mainpage.dox
# This tag can be used to specify the character encoding of the source files