Merge lp:~jelmer/brz/sphinx-only into lp:brz

[Jelmer Vernooij]

Require sphinx for docs building, remove docutils.

Require sphinx for docs building, remove docutils.

This was originally proposed by Ian in https://code.launchpad.net/~ian-clatworthy/bzr/sphinx-only/+merge/26011, but put on hold then because sphinx wasn't widely available.

[Martin Packman (gz)]

Thanks, and retrospective thanks to Ian.

review: Approve

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/86/

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/88/

[The Breezy Bot (the-breezy-bot)]

Merging failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/90/

[The Breezy Bot (the-breezy-bot)]

Project setup failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/93/

=== modified file '.travis.yml'
--- .travis.yml	2018-11-16 15:32:10 +0000
+++ .travis.yml	2018-11-18 19:07:41 +0000
@@ -22,7 +22,7 @@
 install:
   - sudo apt install python-all-dev python3-all-dev subunit
   - travis_retry pip install -U setuptools
-  - travis_retry pip install -U pip coverage codecov flake8 testtools paramiko fastimport configobj cython testscenarios six docutils python-subunit dulwich $TEST_REQUIRE
+  - travis_retry pip install -U pip coverage codecov flake8 testtools paramiko fastimport configobj cython testscenarios six docutils python-subunit dulwich $TEST_REQUIRE sphinx sphinx_epytext
 
 after_success:
   - codecov

=== modified file 'Makefile'
--- Makefile	2018-11-18 16:26:08 +0000
+++ Makefile	2018-11-18 19:07:41 +0000
@@ -118,14 +118,11 @@
 
 ### Documentation ###
 
-# Default to plain documentation for maximum backwards compatibility.
-# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
-
-docs: docs-plain
-
-clean-docs: clean-plain
-
-html-docs: html-plain
+docs: docs-sphinx
+
+clean-docs: clean-sphinx
+
+html-docs: html-sphinx
 
 
 ### Man-page Documentation ###
@@ -216,130 +213,6 @@
 	$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
 
 
-### Plain Documentation ###
-
-# While Sphinx is the preferred tool for building documentation, we still
-# support our "plain" html documentation so that Sphinx is not a hard
-# dependency for packagers on older platforms.
-
-rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
-
-# translate txt docs to html
-derived_txt_files = \
-	doc/en/release-notes/NEWS.txt
-txt_all = \
-	doc/en/tutorials/tutorial.txt \
-	doc/en/tutorials/using_breezy_with_launchpad.txt \
-	doc/en/tutorials/centralized_workflow.txt \
-	$(call sw,doc/*/mini-tutorial/index.txt) \
-	$(call sw,doc/*/user-guide/index-plain.txt) \
-	doc/en/admin-guide/index-plain.txt \
-	$(call sw,doc/es/guia-usario/*.txt) \
-	$(derived_txt_files) \
-	doc/en/upgrade-guide/index.txt \
-	doc/index.txt \
-	$(call sw,doc/index.*.txt)
-txt_nohtml = \
-	doc/en/user-guide/index.txt \
-	doc/en/admin-guide/index.txt
-txt_files = $(filter-out $(txt_nohtml), $(txt_all))
-htm_files = $(patsubst %.txt, %.html, $(txt_files)) 
-
-non_txt_files = \
-       doc/default.css \
-       $(call sw,doc/*/brz-en-quick-reference.svg) \
-       $(call sw,doc/*/brz-en-quick-reference.png) \
-       $(call sw,doc/*/brz-en-quick-reference.pdf) \
-       $(call sw,doc/*/bzr-es-quick-reference.svg) \
-       $(call sw,doc/*/bzr-es-quick-reference.png) \
-       $(call sw,doc/*/bzr-es-quick-reference.pdf) \
-       $(call sw,doc/*/bzr-ru-quick-reference.svg) \
-       $(call sw,doc/*/bzr-ru-quick-reference.png) \
-       $(call sw,doc/*/bzr-ru-quick-reference.pdf) \
-       $(call sw,doc/*/user-guide/images/*.png)
-
-# doc/developers/*.txt files that should *not* be individually
-# converted to HTML
-dev_txt_nohtml = \
-	doc/developers/add.txt \
-	doc/developers/annotate.txt \
-	doc/developers/bundle-creation.txt \
-	doc/developers/commit.txt \
-	doc/developers/diff.txt \
-	doc/developers/directory-fingerprints.txt \
-	doc/developers/gc.txt \
-	doc/developers/implementation-notes.txt \
-	doc/developers/incremental-push-pull.txt \
-	doc/developers/index.txt \
-	doc/developers/initial-push-pull.txt \
-	doc/developers/merge-scaling.txt \
-	doc/developers/miscellaneous-notes.txt \
-	doc/developers/missing.txt \
-	doc/developers/performance-roadmap-rationale.txt \
-	doc/developers/performance-use-case-analysis.txt \
-	doc/developers/planned-change-integration.txt \
-	doc/developers/planned-performance-changes.txt \
-	doc/developers/plans.txt \
-	doc/developers/process.txt \
-	doc/developers/revert.txt \
-	doc/developers/specifications.txt \
-	doc/developers/status.txt \
-	doc/developers/uncommit.txt
-
-dev_txt_all = $(call sw,$(addsuffix /*.txt, doc/developers))
-dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
-dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files)) 
-
-doc/en/user-guide/index-plain.html: $(call sw,$(addsuffix /*.txt, doc/en/user-guide))
-	$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
-
-#doc/es/user-guide/index.html: $(call sw,$(addsuffix /*.txt, doc/es/user-guide))
-#	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
-#
-#doc/ru/user-guide/index.html: $(call sw,$(addsuffix /*.txt, doc/ru/user-guide))
-#	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
-#
-doc/en/admin-guide/index-plain.html: $(call sw,$(addsuffix /*.txt, doc/en/admin-guide))
-	$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
-
-doc/developers/%.html: doc/developers/%.txt
-	$(rst2html) --stylesheet=../default.css $< $@
-
-doc/index.html: doc/index.txt
-	$(rst2html) --stylesheet=default.css $< $@
-
-doc/index.%.html: doc/index.%.txt
-	$(rst2html) --stylesheet=default.css $< $@
-
-%.html: %.txt
-	$(rst2html) --stylesheet=../../default.css $< "$@"
-
-doc/en/release-notes/NEWS.txt: $(NEWS_FILES) tools/generate_release_notes.py
-	$(PYTHON) tools/generate_release_notes.py "$@" $(NEWS_FILES)
-
-upgrade_guide_dependencies =  $(call sw,$(addsuffix /*.txt, doc/en/upgrade-guide))
-
-doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
-	$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
-
-derived_web_docs = $(htm_files) $(dev_htm_files) 
-WEB_DOCS = $(derived_web_docs) $(non_txt_files)
-ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
-
-# the main target to build all the docs
-docs-plain: $(ALL_DOCS)
-
-# produce a tree containing just the final docs, ready for uploading to the web
-HTMLDIR = html_docs
-html-plain: docs-plain
-	$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
-
-# clean produced docs
-clean-plain:
-	$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
-	    $(HTMLDIR) $(derived_txt_files)
-
-
 ### Miscellaneous Documentation Targets ###
 
 # build a png of our performance task list

=== modified file 'breezy/doc_generate/conf.py'
--- breezy/doc_generate/conf.py	2018-11-18 14:23:08 +0000
+++ breezy/doc_generate/conf.py	2018-11-18 19:07:41 +0000
@@ -113,15 +113,15 @@
     # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
     #   midnightblue
     # * gray: dimgray, slategray, lightslategray
-    'sidebarbgcolor': "cornflowerblue",
-    'sidebarlinkcolor': "midnightblue",
-    'relbarbgcolor': "darkblue",
-    'footerbgcolor': "lightslategray",
+    #'sidebarbgcolor': "cornflowerblue",
+    #'sidebarlinkcolor': "midnightblue",
+    #'relbarbgcolor': "darkblue",
+    #'footerbgcolor': "lightslategray",
 
     # Text, heading and code colouring
-    'codebgcolor': "lightyellow",
-    'codetextcolor': "firebrick",
-    'linkcolor': "mediumblue",
+    #'codebgcolor': "lightyellow",
+    #'codetextcolor': "firebrick",
+    #'linkcolor': "mediumblue",
     }
 
 # Add any paths that contain custom themes here, relative to this directory.

=== modified file 'byov.conf'
--- byov.conf	2018-11-18 14:27:52 +0000
+++ byov.conf	2018-11-18 19:07:41 +0000
@@ -25,7 +25,7 @@
 
 # FIXME: Arguably this should be vm.build_deps=brz but it requires either an
 # available package or at least a debian/ dir ? -- vila 2018-02-23
-brz.build_deps = gcc, debhelper, python, python-all-dev, python3-all-dev, python-configobj, python3-configobj, python-docutils, python3-docutils, python-paramiko, python3-paramiko, python-subunit, python3-subunit, python-testtools, python3-testtools, subunit, cython, cython3, python-pip, python3-pip, python-setuptools, python3-setuptools
+brz.build_deps = gcc, debhelper, python, python-all-dev, python3-all-dev, python-configobj, python3-configobj, python-docutils, python3-docutils, python-paramiko, python3-paramiko, python-subunit, python3-subunit, python-testtools, python3-testtools, subunit, cython, cython3, python-pip, python3-pip, python-setuptools, python3-setuptools, python-flake8, python3-flake8, python-sphinx, python3-sphinx
 subunit.build_deps = python-testscenarios, python3-testscenarios, python-testtools, python3-testtools
 vm.packages = {brz.build_deps}, {subunit.build_deps}, bzr, git, python-junitxml
 [brz-xenial]