Haowei Hsu
c48be439f1
Add additional search paths for doxygen on Windows
...
`find_program(DOXYGEN doxygen)` didn't find the executable automatically even if I installed Doxygen on Windows. Therefore, I added some additional search paths.
2022-07-19 08:59:18 -07:00
Victor Zverovich
9c2edfd1aa
Partially revert 638db5 because it breaks the doc build
2020-07-26 09:44:37 -07:00
Vitaly Zaitsev
638db5ca5e
Use Cmake to find Python and Sphinx-doc.
...
Signed-off-by: Vitaly Zaitsev <vitaly@easycoding.org>
2020-07-08 08:06:57 -07:00
Jelle van der Waa
8f2b5fe74d
Don't install sphinx cache files
...
When building documentation sphinx creates cached files in the .doctrees
directory and aren't required for viewing documentation only for
building. As added benefit this makes fmt reprodcubile as the cached
files are different when the build environment is varied.
2020-05-30 06:14:02 -07:00
Victor Zverovich
1b8a216ddf
Improve docs
2018-12-28 15:05:42 -08:00
Victor Zverovich
38f355d87b
Revert "find sphinx-build before calling build.py"
...
This reverts commit 07200f445a
2018-10-28 09:26:21 -07:00
Kefu Chai
10e03e695b
use found python executable for launching sphinx-build
...
there is chance that the distro install python as python3, in that case
the shebang of
```
```
in build.py won't work.
Signed-off-by: Kefu Chai <tchaikov@gmail.com>
2018-10-13 09:14:53 -07:00
Kefu Chai
07200f445a
find sphinx-build before calling build.py
...
this allows us to use sphinx-build-3, as user might already in a python3
world, and distros, like fedora 28, tend to add a "-3" suffix to sphinx-build.
Signed-off-by: Kefu Chai <tchaikov@gmail.com>
2018-10-13 09:14:53 -07:00
Victor Zverovich
e95e4659d9
Add syntax.rst to build
2018-01-20 17:55:43 -08:00
Victor Zverovich
c8efe145b4
Add api.rst to build
2018-01-20 09:52:29 -08:00
Victor Zverovich
9492b9ff03
Pass versions from CMake to Sphinx
2016-06-02 06:41:25 -07:00
Victor Zverovich
fcaf8a0cdc
Make virtualenv dir configurable and break long lines
2016-05-26 06:52:51 -07:00
Victor Zverovich
dc1e36fa0e
Make documentation installation optional ( #333 )
2016-05-24 07:03:08 -07:00
Victor Zverovich
5e1576f79f
cppformat -> fmt
2016-04-24 08:17:47 -07:00
Victor Zverovich
848ab63a2a
CPPFORMAT_VERSION -> FMT_VERSION
2016-04-24 07:16:33 -07:00
vitaut
4118b89139
Get rid of the html directory when installing docs
2015-11-23 08:22:21 -08:00
vitaut
b83fd00183
Pass version from CMake to Sphinx
2015-11-23 08:10:02 -08:00
vitaut
d48047e4c0
Break long line
2015-08-31 08:22:25 -07:00
vitaut
2e874af293
Move CSS compilation to build.py for use by Travis
2015-06-22 06:54:29 -07:00
vitaut
dd6a3bbc7c
Fix out-of-tree documentation build ( #177 )
2015-06-22 06:40:21 -07:00
vitaut
18a55cdb27
Customize Sphinx theme
2015-05-19 08:13:13 -07:00
vitaut
8c24a42395
Make documentation builds more reproducible by using virtualenv
2015-04-10 08:39:09 -07:00
vitaut
d2ada77ccc
Install documentation
2015-04-09 07:21:42 -07:00
Victor Zverovich
c3e845ab7e
Only enable doc target if breathe is available
2015-03-01 16:35:29 -08:00
Victor Zverovich
b4eef59100
Only add the doc target if doxygen and sphinx-build are available
2015-01-30 12:53:52 -08:00
Victor Zverovich
90bc8dd3ed
Don't track the dependencies of the doc target as Sphinx does it itself
2015-01-30 08:49:48 -08:00
Victor Zverovich
45397e5046
Add dependency from CMakeLists.txt since it is used to get version.
2014-08-21 08:51:45 -07:00
Victor Zverovich
4c563de76f
Use stock version of sphinx build.
2014-07-27 10:07:20 -07:00
Victor Zverovich
891da2f474
Fix docs.
2014-05-13 07:39:18 -07:00
Victor Zverovich
660938fe4d
Add sphinx and breathe at top level.
2014-05-13 07:32:28 -07:00
Victor Zverovich
76d9a103e1
Update dependencies.
2014-05-13 06:15:18 -07:00
Victor Zverovich
028fb01f42
Make docs depend on layout.
2014-04-22 06:34:31 -07:00
Victor Zverovich
10b2fe0f27
Implement packaging.
2014-04-14 12:54:03 -07:00
Victor Zverovich
00830b99b3
Document the API using breathe.
2013-01-03 08:57:34 -08:00
Victor Zverovich
5ec28a4914
Use breathe + doxygen for API documentation.
2012-12-29 09:27:26 -08:00
Victor Zverovich
c1ca4a4574
Add docs.
2012-12-18 06:49:18 -08:00
