Skip to content

Commit 1640c4e

Browse files
committed
CDRIVER-1979 build docs with sphinx-build
1 parent e348980 commit 1640c4e

14 files changed

+40
-821
lines changed

build/autotools/CheckProgs.m4

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ fi
1616
AC_CHECK_HEADERS_ONCE([strings.h])
1717

1818
# Optional for documentation
19-
AC_PATH_PROG(YELP_BUILD, yelp-build)
19+
AC_PATH_PROG(SPHINX_BUILD, sphinx-build)
2020

2121
AC_PROG_INSTALL
2222

build/autotools/ReadCommandLineArguments.m4

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,6 @@ AC_ARG_ENABLE([man-pages],
9696
[],
9797
[enable_man_pages=no])
9898

99-
AC_ARG_ENABLE([yelp],
100-
[AS_HELP_STRING([--enable-yelp=@<:@yes/no@:>@],
101-
[Install yelp manuals.])],
102-
[],
103-
[enable_yelp=no])
104-
10599
AC_ARG_ENABLE([examples],
106100
[AS_HELP_STRING([--enable-examples=@<:@yes/no@:>@],
107101
[Build MongoDB C Driver examples.])],

build/autotools/SetupAutomake.m4

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ AM_CONDITIONAL([ENABLE_TESTS],[test "$enable_tests" = "yes"])
3737

3838
# Should we build man pages
3939
AM_CONDITIONAL([ENABLE_MAN_PAGES],[test "$enable_man_pages" = "yes"])
40+
AS_IF([test "$enable_man_pages" = "yes" && test -z "$SPHINX_BUILD"],
41+
[AC_MSG_ERROR([The Sphinx Python package must be installed to generate man pages.])])
4042

4143
# Should we build HTML documentation
4244
AM_CONDITIONAL([ENABLE_HTML_DOCS],[test "$enable_html_docs" = "yes"])
43-
AS_IF([test "$enable_html_docs" = "yes" && test -z "$YELP_BUILD"],
44-
[AC_MSG_ERROR([yelp-build must be installed to generate HTML documentation.])])
45+
AS_IF([test "$enable_html_docs" = "yes" && test -z "$SPHINX_BUILD"],
46+
[AC_MSG_ERROR([The Sphinx Python package must be installed to generate HTML documentation.])])

build/libmongoc.xsl

Lines changed: 0 additions & 93 deletions
This file was deleted.

build/version.in

Lines changed: 0 additions & 1 deletion
This file was deleted.

build/version.xml

Lines changed: 0 additions & 3 deletions
This file was deleted.

configure.ac

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,10 @@ m4_include([build/autotools/SetupAutomake.m4])
5656

5757
AC_CONFIG_FILES([
5858
Makefile
59-
build/version
6059
src/libmongoc-1.0.pc
6160
src/libmongoc-ssl-1.0.pc
6261
src/mongoc/mongoc-config.h
6362
src/mongoc/mongoc-version.h
64-
doc/mongoc_installing.page
65-
doc/mongoc_version.page
6663
])
6764

6865
m4_include([build/autotools/Libbson.m4])

doc/.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,3 @@ html/_static
1111
html/.buildinfo
1212
html/.nojekyll
1313
man/*.3
14-
mongoc_installing.page
15-
mongoc_version.page

doc/Makefile.am

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
EXTRA_DIST += doc/mallard2man.py build/libmongoc.xsl build/version.xml
2-
31
dist-hook: man html

doc/html/Makefile.am

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,37 @@ CLEANFILES += $(wildcard doc/html/*.png)
55

66
.PHONY: doc/html
77

8+
# "E" is "ignore cache", and "d" sets the dir to save cachefiles in.
89
doc/html:
910
-mkdir -p doc/html
10-
$(AM_V_GEN)$(YELP_BUILD) html -x $(top_srcdir)/build/libmongoc.xsl -o doc/html/ doc
11+
$(SPHINX_BUILD) -qEW -d /tmp/sphinx-cache-dir doc doc/html
1112

12-
YELP_HTML_FILES = \
13-
doc/html/C.css \
14-
doc/html/jquery.js \
15-
doc/html/jquery.syntax.brush.clang.js \
16-
doc/html/jquery.syntax.core.js \
17-
doc/html/jquery.syntax.js \
18-
doc/html/jquery.syntax.layout.yelp.js \
19-
doc/html/yelp-note-tip.png \
20-
doc/html/yelp-note-warning.png \
21-
doc/html/yelp-note.png \
22-
doc/html/yelp.js
13+
SPHINX_HTML_FILES = \
14+
doc/html/.nojekyll \
15+
doc/html/_static \
16+
doc/html/_static/ajax-loader.gif \
17+
doc/html/_static/basic.css \
18+
doc/html/_static/comment-bright.png \
19+
doc/html/_static/comment-close.png \
20+
doc/html/_static/comment.png \
21+
doc/html/_static/doctools.js \
22+
doc/html/_static/down-pressed.png \
23+
doc/html/_static/down.png \
24+
doc/html/_static/file.png \
25+
doc/html/_static/jquery-3.1.0.js \
26+
doc/html/_static/jquery.js \
27+
doc/html/_static/minus.png \
28+
doc/html/_static/mongoc.css \
29+
doc/html/_static/plus.png \
30+
doc/html/_static/pygments.css \
31+
doc/html/_static/searchtools.js \
32+
doc/html/_static/underscore-1.3.1.js \
33+
doc/html/_static/underscore.js \
34+
doc/html/_static/up-pressed.png \
35+
doc/html/_static/up.png \
36+
doc/html/_static/websupport.js \
37+
doc/html/objects.inv \
38+
doc/html/searchindex.js
2339

2440
EXTRA_DIST += doc/html
25-
EXTRA_DIST += $(YELP_HTML_FILES)
26-
41+
EXTRA_DIST += $(SPHINX_HTML_FILES)

0 commit comments

Comments
 (0)