factor out the documentation header into separate rst file

This commit is contained in:
arvidn 2018-10-01 11:34:06 +02:00 committed by Arvid Norberg
parent d2f19a2d73
commit c096f63f59
22 changed files with 26 additions and 35 deletions

View File

@ -85,6 +85,7 @@ DOCS_PAGES = \
docs/utp.rst \ docs/utp.rst \
docs/streaming.rst \ docs/streaming.rst \
docs/tutorial.rst \ docs/tutorial.rst \
docs/header.rst \
docs/tutorial.html \ docs/tutorial.html \
docs/reference-Alerts.html \ docs/reference-Alerts.html \
docs/reference-Bdecoding.html \ docs/reference-Bdecoding.html \

View File

@ -2,8 +2,7 @@
libtorrent manual libtorrent manual
================= =================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -2,6 +2,8 @@
client_test example program client_test example program
=========================== ===========================
.. include:: header.rst
Client test is a, more or less, complete bittorrent client. It lacks most 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 settings and you can't start or stop torrents once you've started it. All
the settings are hardcoded. The commandline arguments are:: the settings are hardcoded. The commandline arguments are::

View File

@ -2,8 +2,7 @@
libtorrent manual libtorrent manual
================= =================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -1,8 +1,8 @@
:Author: Arvid Norberg, arvid@libtorrent.org
Mainline DHT extensions Mainline DHT extensions
======================= =======================
.. include:: header.rst
libtorrent implements a few extensions to the Mainline DHT protocol. libtorrent implements a few extensions to the Mainline DHT protocol.
get_peers response get_peers response

View File

@ -2,8 +2,7 @@
BitTorrent extension for DHT RSS feeds BitTorrent extension for DHT RSS feeds
====================================== ======================================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -2,8 +2,7 @@
BitTorrent DHT security extension BitTorrent DHT security extension
================================= =================================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -2,8 +2,7 @@
BitTorrent extension for arbitrary DHT store BitTorrent extension for arbitrary DHT store
============================================ ============================================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -2,8 +2,7 @@
libtorrent Examples libtorrent Examples
=================== ===================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -2,8 +2,7 @@
libtorrent manual libtorrent manual
================= =================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -1135,9 +1135,7 @@ for cat in categories:
functions = categories[cat]['functions'] functions = categories[cat]['functions']
enums = categories[cat]['enums'] enums = categories[cat]['enums']
out.write(''' out.write('''.. include:: header.rst
:Author: Arvid Norberg, arvid@libtorrent.org
:Version: 1.2.0
`home`__ `home`__

View File

@ -2,8 +2,7 @@
libtorrent hacking libtorrent hacking
================== ==================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

3
docs/header.rst Normal file
View File

@ -0,0 +1,3 @@
:Author: Arvid Norberg, arvid@libtorrent.org
:Version: 1.2.0

View File

@ -1,5 +1,4 @@
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. raw:: html .. raw:: html

View File

@ -2,8 +2,7 @@
libtorrent API Documentation libtorrent API Documentation
============================ ============================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 1 :depth: 1

View File

@ -2,7 +2,7 @@
libtorrent python binding libtorrent python binding
========================= =========================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -1,6 +1,8 @@
Streaming implementation Streaming implementation
======================== ========================
.. include:: header.rst
This documents describes the algorithm libtorrent uses to satisfy time critical This documents describes the algorithm libtorrent uses to satisfy time critical
piece requests, i.e. streaming. piece requests, i.e. streaming.

View File

@ -2,8 +2,7 @@
libtorrent manual libtorrent manual
================= =================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -2,8 +2,7 @@
libtorrent manual libtorrent manual
================= =================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -2,8 +2,7 @@
libtorrent manual libtorrent manual
================= =================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2

View File

@ -3,7 +3,6 @@ Upgrading to libtorrent 1.2
=========================== ===========================
:Author: Arvid Norberg, arvid@libtorrent.org :Author: Arvid Norberg, arvid@libtorrent.org
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 1 :depth: 1

View File

@ -2,8 +2,7 @@
libtorrent manual libtorrent manual
================= =================
:Author: Arvid Norberg, arvid@libtorrent.org .. include:: header.rst
:Version: 1.2.0
.. contents:: Table of contents .. contents:: Table of contents
:depth: 2 :depth: 2