Skip to content

Commit 58de3d2

Browse files
glynosglynos
committed
Updated documentation style, minor fixes to docs based on feedback.
1 parent 17d7551 commit 58de3d2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+271
-311
lines changed

‎libs/network/doc/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_build

‎libs/network/doc/_static/Button-Info-icon.png

3.42 KB
Loading

‎libs/network/doc/_static/Button-Warning-icon.png

2.84 KB
Loading

‎libs/network/doc/_static/cpp-netlib.css

+11-12
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22

33
html,body
44
{
5-
background-image: url('./orange-background.jpg');
65
background-repeat: no-repeat;
76
background-position: left top;
87
background-attachment: fixed;
9-
background-color: black;
8+
background-color: #f80;
109
}
1110

1211
body
@@ -158,9 +157,9 @@ a.reference em
158157
div.nav
159158
{
160159
margin: 0;
161-
font-size: 12px;
160+
font-size: 14px;
162161
text-align: right;
163-
color: #487858
162+
color: #fff
164163
}
165164

166165
div.nav a: link,div.nav a: visited
@@ -539,7 +538,7 @@ dt .literal,table .literal
539538
{
540539
padding: .8em 1em .8em;
541540
margin: 1em 0;
542-
background-color: #E8FFE8;
541+
background-color: #6ABDFB;
543542
-moz-border-radius: 3px;
544543
-moz-box-shadow: 0 1px 2px rgba(0,0,0,0.3);
545544
-webkit-border-radius: 3px;
@@ -560,16 +559,16 @@ dt .literal,table .literal
560559
margin-bottom: 0 !important
561560
}
562561

563-
div.admonition-philosophy
562+
.note
564563
{
565-
padding-left: 65px;
566-
background: url(docicons-philosophy.png) .8em .8em no-repeat
564+
padding-left: 85px;
565+
background: #6ABDFB url(Button-Info-icon.png) .8em .8em no-repeat
567566
}
568567

569-
div.admonition-behind-the-scenes
568+
.warning
570569
{
571-
padding-left: 65px;
572-
background: url(docicons-behindscenes.png) .8em .8em no-repeat
570+
padding-left: 85px;
571+
background: #6ABDFB url(Button-Warning-icon.png) .8em .8em no-repeat
573572
}
574573

575574
/*** versoinadded/changes ***/
@@ -671,7 +670,7 @@ img
671670
}
672671

673672
#index #cpp-netlib-getting-cpp-netlib, #index #cpp-netlib-boost {
674-
background:none repeat scroll 0 0 #E8FFE8;
673+
background:none repeat scroll 0 0 #6ABDFB;
675674
margin: 2em 0 2em 2em;
676675

677676
border-radius:6px 6px;

‎libs/network/doc/_templates/layout.html

+6-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,12 @@
3737
<h1><a href="{{ pathto('index') }}">{{ docstitle }}</a></h1>
3838
<div id="global-nav">
3939
<a title="Home page" href="{{ pathto('index') }}">Home</a> {{ reldelim2 }}
40-
<a title="Table of contents" href="{{ pathto('contents') }}">Table of contents</a>
40+
<a title="Table of contents" href="{{ pathto('contents') }}">Table of contents</a> |
41+
<a title="What's new" href="{{ pathto('whats_new') }}">What's new</a> |
42+
<a title="Getting started" href="{{ pathto('getting_started') }}">Getting started</a> |
43+
<a title="Examples" href="{{ pathto('examples') }}">Examples</a> |
44+
<a title="In depth" href="{{ pathto('in_depth') }}">In depth</a> |
45+
<a title="Reference" href="{{ pathto('reference') }}">Reference</a>
4146
</div>
4247
<div class="nav">{{ secondnav() }}</div>
4348
</div>
@@ -100,6 +105,5 @@ <h3>You are here:</h3>
100105
{% block footer %}
101106
<div class="footer">
102107
documentation automatically generated by <a href="http://sphinx.pocoo.org">Sphinx</a> | style mostly stolen from <a href="http://lettuce.it">lettuce.it</a>
103-
| background image attributed to <a href="http://www.flickr.com/photos/OrangeSmell">OrangeSmell</a>
104108
</div>
105109
{% endblock %}

‎libs/network/doc/examples.rst

+16-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,19 @@ common networking protocols. The following set of examples describe a
99
series of realistic examples that use the :mod:`cpp-netlib` for these
1010
kinds of application. All examples are built using CMake.
1111

12-
.. include:: examples_http.rst
12+
HTTP examples
13+
`````````````
14+
15+
The HTTP component of the :mod:`cpp-netlib` contains a client and server.
16+
The examples that follow show how to use both for programs that can be
17+
embedded into larger applications.
18+
19+
.. toctree::
20+
:maxdepth: 1
21+
22+
examples/http/http_client
23+
examples/http/simple_wget
24+
examples/http/hello_world_server
25+
examples/http/hello_world_client
26+
examples/http/atom_reader
27+
examples/http/twitter_search

‎libs/network/doc/examples_http.rst

-16
This file was deleted.

‎libs/network/doc/getting_started.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ refer to the `Git documentation`_.
3838

3939
.. note:: Previous versions of :mod:`cpp-netlib` referred to the
4040
*mikhailberis* repository as the main development repository. This
41-
account is still valid, but not always up-to-date. In interest of
41+
account is still valid, but not always up-to-date. In the interest of
4242
consistency, the main repository has been changed to *cpp-netlib*.
4343

4444
Windows users need to use msysGit_, and to invoke the command above

‎libs/network/doc/html/_images/boost1.png

-13.1 KB
Binary file not shown.

‎libs/network/doc/html/_images/boost2.png

-13.1 KB
Binary file not shown.

‎libs/network/doc/html/_images/boost3.png

-13.1 KB
Binary file not shown.

‎libs/network/doc/html/_images/boost4.png

-13.1 KB
Binary file not shown.

‎libs/network/doc/html/_images/boost5.png

-13.1 KB
Binary file not shown.

‎libs/network/doc/html/_images/boost6.png

-13.1 KB
Binary file not shown.

‎libs/network/doc/html/_sources/examples.txt

+16-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,19 @@ common networking protocols. The following set of examples describe a
99
series of realistic examples that use the :mod:`cpp-netlib` for these
1010
kinds of application. All examples are built using CMake.
1111

12-
.. include:: examples_http.rst
12+
HTTP examples
13+
`````````````
14+
15+
The HTTP component of the :mod:`cpp-netlib` contains a client and server.
16+
The examples that follow show how to use both for programs that can be
17+
embedded into larger applications.
18+
19+
.. toctree::
20+
:maxdepth: 1
21+
22+
examples/http/http_client
23+
examples/http/simple_wget
24+
examples/http/hello_world_server
25+
examples/http/hello_world_client
26+
examples/http/atom_reader
27+
examples/http/twitter_search

‎libs/network/doc/html/_sources/examples_http.txt

-16
This file was deleted.

‎libs/network/doc/html/_sources/getting_started.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ refer to the `Git documentation`_.
3838

3939
.. note:: Previous versions of :mod:`cpp-netlib` referred to the
4040
*mikhailberis* repository as the main development repository. This
41-
account is still valid, but not always up-to-date. In interest of
41+
account is still valid, but not always up-to-date. In the interest of
4242
consistency, the main repository has been changed to *cpp-netlib*.
4343

4444
Windows users need to use msysGit_, and to invoke the command above

‎libs/network/doc/html/_sources/index.txt

+5-3
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,11 @@ Want to learn more?
115115
* :ref:`Study the library in more depth <in_depth>`
116116
* :ref:`Discover more through the full reference <reference>`
117117

118-
.. warning:: Be aware that not all features are stable. The message
119-
design is under review and the HTTP client implementation will
120-
undergo a major refactoring.
118+
.. warning:: Be aware that not all features are stable. The generic
119+
message design is under review and the URI and HTTP
120+
client implementation will continue to undergo
121+
refactoring. Future versions will include support for
122+
other network protocols.
121123

122124

123125
.. _Boost: http://www.boost.org/

‎libs/network/doc/html/_sources/whats_new.txt

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
v0.9.3
1111
~~~~~~
12+
* URI, HTTP client and HTTP server are now built as static libraries.
1213
* Updated URI parser.
1314
* A new URI builder.
1415
* URI support for IPv6 RFC 2732.

‎libs/network/doc/html/_static/Button-Info-icon.png

3.42 KB
Loading

‎libs/network/doc/html/_static/Button-Warning-icon.png

2.84 KB
Loading

‎libs/network/doc/html/_static/cpp-netlib.css

+11-12
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,10 @@
22

33
html,body
44
{
5-
background-image: url('./orange-background.jpg');
65
background-repeat: no-repeat;
76
background-position: left top;
87
background-attachment: fixed;
9-
background-color: black;
8+
background-color: #f80;
109
}
1110

1211
body
@@ -158,9 +157,9 @@ a.reference em
158157
div.nav
159158
{
160159
margin: 0;
161-
font-size: 12px;
160+
font-size: 14px;
162161
text-align: right;
163-
color: #487858
162+
color: #fff
164163
}
165164

166165
div.nav a: link,div.nav a: visited
@@ -539,7 +538,7 @@ dt .literal,table .literal
539538
{
540539
padding: .8em 1em .8em;
541540
margin: 1em 0;
542-
background-color: #E8FFE8;
541+
background-color: #6ABDFB;
543542
-moz-border-radius: 3px;
544543
-moz-box-shadow: 0 1px 2px rgba(0,0,0,0.3);
545544
-webkit-border-radius: 3px;
@@ -560,16 +559,16 @@ dt .literal,table .literal
560559
margin-bottom: 0 !important
561560
}
562561

563-
div.admonition-philosophy
562+
.note
564563
{
565-
padding-left: 65px;
566-
background: url(docicons-philosophy.png) .8em .8em no-repeat
564+
padding-left: 85px;
565+
background: #6ABDFB url(Button-Info-icon.png) .8em .8em no-repeat
567566
}
568567

569-
div.admonition-behind-the-scenes
568+
.warning
570569
{
571-
padding-left: 65px;
572-
background: url(docicons-behindscenes.png) .8em .8em no-repeat
570+
padding-left: 85px;
571+
background: #6ABDFB url(Button-Warning-icon.png) .8em .8em no-repeat
573572
}
574573

575574
/*** versoinadded/changes ***/
@@ -671,7 +670,7 @@ img
671670
}
672671

673672
#index #cpp-netlib-getting-cpp-netlib, #index #cpp-netlib-boost {
674-
background:none repeat scroll 0 0 #E8FFE8;
673+
background:none repeat scroll 0 0 #6ABDFB;
675674
margin: 2em 0 2em 2em;
676675

677676
border-radius:6px 6px;

‎libs/network/doc/html/contents.html

+14-38
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,12 @@
4747
<h1><a href="index.html">cpp-netlib v0.9.3</a></h1>
4848
<div id="global-nav">
4949
<a title="Home page" href="index.html">Home</a> |
50-
<a title="Table of contents" href="#">Table of contents</a>
50+
<a title="Table of contents" href="#">Table of contents</a> |
51+
<a title="What's new" href="whats_new.html">What's new</a> |
52+
<a title="Getting started" href="getting_started.html">Getting started</a> |
53+
<a title="Examples" href="examples.html">Examples</a> |
54+
<a title="In depth" href="in_depth.html">In depth</a> |
55+
<a title="Reference" href="reference.html">Reference</a>
5156
</div>
5257
<div class="nav">
5358
<a title="cpp-netlib v0.9.3" href="index.html" accesskey="U">up</a>
@@ -91,42 +96,14 @@ <h1><a href="index.html">cpp-netlib v0.9.3</a></h1>
9196
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#reporting-issues-getting-support">Reporting Issues, Getting Support</a></li>
9297
</ul>
9398
</li>
94-
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
95-
<li class="toctree-l1"><a class="reference internal" href="examples.html#http-examples">HTTP examples</a><ul>
96-
<li class="toctree-l2"><a class="reference internal" href="examples/http/http_client.html">HTTP client</a><ul>
97-
<li class="toctree-l3"><a class="reference internal" href="examples/http/http_client.html#the-code">The code</a></li>
98-
<li class="toctree-l3"><a class="reference internal" href="examples/http/http_client.html#running-the-example">Running the example</a></li>
99-
<li class="toctree-l3"><a class="reference internal" href="examples/http/http_client.html#diving-into-the-code">Diving into the code</a></li>
100-
</ul>
101-
</li>
102-
<li class="toctree-l2"><a class="reference internal" href="examples/http/simple_wget.html">Simple <cite>wget</cite></a><ul>
103-
<li class="toctree-l3"><a class="reference internal" href="examples/http/simple_wget.html#the-code">The code</a></li>
104-
<li class="toctree-l3"><a class="reference internal" href="examples/http/simple_wget.html#running-the-example">Running the example</a></li>
105-
<li class="toctree-l3"><a class="reference internal" href="examples/http/simple_wget.html#diving-into-the-code">Diving into the code</a></li>
106-
</ul>
107-
</li>
108-
<li class="toctree-l2"><a class="reference internal" href="examples/http/hello_world_server.html">&#8220;Hello world&#8221; HTTP server</a><ul>
109-
<li class="toctree-l3"><a class="reference internal" href="examples/http/hello_world_server.html#the-code">The code</a></li>
110-
<li class="toctree-l3"><a class="reference internal" href="examples/http/hello_world_server.html#building-and-running-the-server">Building and running the server</a></li>
111-
<li class="toctree-l3"><a class="reference internal" href="examples/http/hello_world_server.html#diving-into-the-code">Diving into the code</a></li>
112-
</ul>
113-
</li>
114-
<li class="toctree-l2"><a class="reference internal" href="examples/http/hello_world_client.html">&#8220;Hello world&#8221; HTTP client</a><ul>
115-
<li class="toctree-l3"><a class="reference internal" href="examples/http/hello_world_client.html#the-code">The code</a></li>
116-
<li class="toctree-l3"><a class="reference internal" href="examples/http/hello_world_client.html#building-and-running-the-client">Building and running the client</a></li>
117-
<li class="toctree-l3"><a class="reference internal" href="examples/http/hello_world_client.html#diving-into-the-code">Diving into the code</a></li>
118-
</ul>
119-
</li>
120-
<li class="toctree-l2"><a class="reference internal" href="examples/http/atom_reader.html">Atom feed reader</a><ul>
121-
<li class="toctree-l3"><a class="reference internal" href="examples/http/atom_reader.html#the-code">The code</a></li>
122-
<li class="toctree-l3"><a class="reference internal" href="examples/http/atom_reader.html#building-and-running-atom-reader">Building and running <tt class="docutils literal"><span class="pre">atom_reader</span></tt></a></li>
123-
<li class="toctree-l3"><a class="reference internal" href="examples/http/atom_reader.html#diving-into-the-code">Diving into the code</a></li>
124-
</ul>
125-
</li>
126-
<li class="toctree-l2"><a class="reference internal" href="examples/http/twitter_search.html">Twitter search</a><ul>
127-
<li class="toctree-l3"><a class="reference internal" href="examples/http/twitter_search.html#the-code">The code</a></li>
128-
<li class="toctree-l3"><a class="reference internal" href="examples/http/twitter_search.html#building-and-running-twitter-search">Building and running <tt class="docutils literal"><span class="pre">twitter_search</span></tt></a></li>
129-
<li class="toctree-l3"><a class="reference internal" href="examples/http/twitter_search.html#diving-into-the-code">Diving into the code</a></li>
99+
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
100+
<li class="toctree-l2"><a class="reference internal" href="examples.html#http-examples">HTTP examples</a><ul>
101+
<li class="toctree-l3"><a class="reference internal" href="examples/http/http_client.html">HTTP client</a></li>
102+
<li class="toctree-l3"><a class="reference internal" href="examples/http/simple_wget.html">Simple <cite>wget</cite></a></li>
103+
<li class="toctree-l3"><a class="reference internal" href="examples/http/hello_world_server.html">&#8220;Hello world&#8221; HTTP server</a></li>
104+
<li class="toctree-l3"><a class="reference internal" href="examples/http/hello_world_client.html">&#8220;Hello world&#8221; HTTP client</a></li>
105+
<li class="toctree-l3"><a class="reference internal" href="examples/http/atom_reader.html">Atom feed reader</a></li>
106+
<li class="toctree-l3"><a class="reference internal" href="examples/http/twitter_search.html">Twitter search</a></li>
130107
</ul>
131108
</li>
132109
</ul>
@@ -270,7 +247,6 @@ <h3>Quick search</h3>
270247
</div>
271248
<div class="footer">
272249
documentation automatically generated by <a href="http://sphinx.pocoo.org">Sphinx</a> | style mostly stolen from <a href="http://lettuce.it">lettuce.it</a>
273-
| background image attributed to <a href="http://www.flickr.com/photos/OrangeSmell">OrangeSmell</a>
274250
</div>
275251

276252
</body>

0 commit comments

Comments
 (0)