Skip to content

Commit 6f492e0

Browse files
committed
Updated documentation templates. I have a better idea of the document structure now.
1 parent d8585d0 commit 6f492e0

File tree

7 files changed

+101
-0
lines changed

7 files changed

+101
-0
lines changed

libs/network/doc/rst/cpp-netlib.rst

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,68 @@
22
C++ Network Library
33
=====================
44

5+
:Authors: Glyn Matthews <glyn.matthews@gmail.com>
6+
Dean Michael Berris <mikhailberis@gmail.com>
7+
:Date: Jun 16, 2010
8+
:Version: 2.0
9+
:Description: Complete documentation, with examples, for using the cpp-netlib.
10+
11+
-------------
12+
Quick Start
13+
-------------
14+
15+
.. include:: quick_start.rst
16+
17+
------
18+
HTTP
19+
------
20+
21+
.. include:: http.rst
22+
23+
------
24+
HTTP
25+
------
26+
27+
.. include:: xmpp.rst
28+
29+
-----
30+
URI
31+
-----
32+
33+
.. include:: uri.rst
34+
35+
------------
36+
Techniques
37+
------------
38+
39+
.. include:: techniques.rst
40+
41+
------------
42+
Motivation
43+
------------
44+
45+
.. include:: motivation.rst
46+
47+
------------
48+
Objectives
49+
------------
50+
51+
.. include:: objectives.rst
52+
53+
---------
54+
History
55+
---------
56+
57+
.. include:: history.rst
58+
59+
----------
60+
Pitfalls
61+
----------
62+
63+
.. include:: pitfalls.rst
64+
65+
------------
66+
References
67+
------------
68+
69+
.. include:: reference.rst

libs/network/doc/rst/http.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1+
.. include:: http/hello_world_client.rst
12

3+
.. include:: http/hello_world_server.rst
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

libs/network/doc/rst/quick_start.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,30 @@
1+
Downloading the source
2+
======================
3+
4+
Stable
5+
------
6+
7+
Downloading from Github
8+
-----------------------
9+
10+
Configuring `cpp-netlib`
11+
========================
12+
13+
Getting Boost
14+
-------------
15+
16+
Getting CMake
17+
-------------
18+
19+
Instructions for Windows Users
20+
------------------------------
21+
22+
Instructions for Linux Users
23+
----------------------------
24+
25+
Building and Running the Examples
26+
---------------------------------
27+
28+
Troubleshooting
29+
===============
130

libs/network/doc/rst/uri.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

libs/network/doc/rst/xmpp.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
XMPP Client
2+
===========

0 commit comments

Comments
 (0)