factor out the documentation header into separate rst file

2018-10-01 11:34:06 +02:00 · 2018-10-01 11:34:06 +02:00 · c096f63f59
parent d2f19a2d73
commit c096f63f59
22 changed files with 26 additions and 35 deletions
--- a/Makefile.am
+++ b/Makefile.am
@ -85,6 +85,7 @@ DOCS_PAGES = \
  docs/utp.rst                    \
  docs/streaming.rst              \
  docs/tutorial.rst               \
+  docs/header.rst                 \
  docs/tutorial.html              \
  docs/reference-Alerts.html      \
  docs/reference-Bdecoding.html   \
--- a/docs/building.rst
+++ b/docs/building.rst
@ -2,8 +2,7 @@
 libtorrent manual
 =================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/client_test.rst
+++ b/docs/client_test.rst
@ -2,6 +2,8 @@
 client_test example program
 ===========================

+.. include:: header.rst
+
 Client test is a, more or less, complete bittorrent client. It lacks most
 settings and you can't start or stop torrents once you've started it. All
 the settings are hardcoded. The commandline arguments are::
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@ -2,8 +2,7 @@
 libtorrent manual
 =================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/dht_extensions.rst
+++ b/docs/dht_extensions.rst
@ -1,8 +1,8 @@
-:Author: Arvid Norberg, arvid@libtorrent.org
-
 Mainline DHT extensions
 =======================

+.. include:: header.rst
+
 libtorrent implements a few extensions to the Mainline DHT protocol.

 get_peers response
--- a/docs/dht_rss.rst
+++ b/docs/dht_rss.rst
@ -2,8 +2,7 @@
 BitTorrent extension for DHT RSS feeds
 ======================================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/dht_sec.rst
+++ b/docs/dht_sec.rst
@ -2,8 +2,7 @@
 BitTorrent DHT security extension
 =================================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/dht_store.rst
+++ b/docs/dht_store.rst
@ -2,8 +2,7 @@
 BitTorrent extension for arbitrary DHT store
 ============================================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/examples.rst
+++ b/docs/examples.rst
@ -2,8 +2,7 @@
 libtorrent Examples
 ===================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/features.rst
+++ b/docs/features.rst
@ -2,8 +2,7 @@
 libtorrent manual
 =================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/gen_reference_doc.py
+++ b/docs/gen_reference_doc.py
@ -1135,9 +1135,7 @@ for cat in categories:
    functions = categories[cat]['functions']
    enums = categories[cat]['enums']

-    out.write('''
-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+    out.write('''.. include:: header.rst

 `home`__

--- a/docs/hacking.rst
+++ b/docs/hacking.rst
@ -2,8 +2,7 @@
 libtorrent hacking
 ==================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/header.rst
+++ b/docs/header.rst
@ -0,0 +1,3 @@
+:Author: Arvid Norberg, arvid@libtorrent.org
+:Version: 1.2.0
+
--- a/docs/index.rst
+++ b/docs/index.rst
@ -1,5 +1,4 @@
-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. raw:: html

--- a/docs/manual.rst
+++ b/docs/manual.rst
@ -2,8 +2,7 @@
 libtorrent API Documentation
 ============================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 1
--- a/docs/python_binding.rst
+++ b/docs/python_binding.rst
@ -2,7 +2,7 @@
 libtorrent python binding
 =========================

-:Author: Arvid Norberg, arvid@libtorrent.org
+.. include:: header.rst

 .. contents:: Table of contents
 	:depth: 2
--- a/docs/streaming.rst
+++ b/docs/streaming.rst
@ -1,6 +1,8 @@
 Streaming implementation
 ========================

+.. include:: header.rst
+
 This documents describes the algorithm libtorrent uses to satisfy time critical
 piece requests, i.e. streaming.

--- a/docs/troubleshooting.rst
+++ b/docs/troubleshooting.rst
@ -2,8 +2,7 @@
 libtorrent manual
 =================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/tuning.rst
+++ b/docs/tuning.rst
@ -2,8 +2,7 @@
 libtorrent manual
 =================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/tutorial.rst
+++ b/docs/tutorial.rst
@ -2,8 +2,7 @@
 libtorrent manual
 =================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2
--- a/docs/upgrade_to_1.2.rst
+++ b/docs/upgrade_to_1.2.rst
@ -3,7 +3,6 @@ Upgrading to libtorrent 1.2
 ===========================

 :Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0

 .. contents:: Table of contents
  :depth: 1
--- a/docs/utp.rst
+++ b/docs/utp.rst
@ -2,8 +2,7 @@
 libtorrent manual
 =================

-:Author: Arvid Norberg, arvid@libtorrent.org
-:Version: 1.2.0
+.. include:: header.rst

 .. contents:: Table of contents
  :depth: 2