From 46b9bb8ef718a98fffd0a877788b41c63af52fb1 Mon Sep 17 00:00:00 2001 From: Michael Dowling Date: Fri, 1 Nov 2013 11:49:42 -0700 Subject: [PATCH] Updating to latest version of the docs theme --- docs/_static/homepage.css | 1 + docs/_templates/index.html | 4 +- docs/_templates/leftbar.html | 10 --- docs/_templates/nav_links.html | 1 - docs/conf.py | 2 + docs/docs.rst | 117 +++++++++++++-------------------- docs/requirements.txt | 2 +- 7 files changed, 50 insertions(+), 87 deletions(-) diff --git a/docs/_static/homepage.css b/docs/_static/homepage.css index 024c5a9c..70c46d8d 100644 --- a/docs/_static/homepage.css +++ b/docs/_static/homepage.css @@ -62,6 +62,7 @@ padding: 40px 0 30px; margin-bottom: 0; color: #fff; + margin-top: -19px; } .masthead h1 { diff --git a/docs/_templates/index.html b/docs/_templates/index.html index 8268cee9..e6d188ea 100644 --- a/docs/_templates/index.html +++ b/docs/_templates/index.html @@ -8,8 +8,8 @@

Guzzle

Guzzle is a PHP HTTP client
& framework for building RESTful web service clients.

- View Guzzle on GitHub - Read the docs + View Guzzle on GitHub + Read the docs

diff --git a/docs/_templates/leftbar.html b/docs/_templates/leftbar.html index 5786f7ac..e69de29b 100644 --- a/docs/_templates/leftbar.html +++ b/docs/_templates/leftbar.html @@ -1,10 +0,0 @@ -
-

Need help?

-

Please post to our google group or #guzzlephp IRC channel on freenode if you need support or have a technical - question.

-
-
-

Found an error?

-

If you find an error in the documentation, please file a ticket or submit a pull request on - GitHub

-
diff --git a/docs/_templates/nav_links.html b/docs/_templates/nav_links.html index 985c58f6..d4f2165b 100644 --- a/docs/_templates/nav_links.html +++ b/docs/_templates/nav_links.html @@ -2,5 +2,4 @@
  • API
  • GitHub
  • Forum
    • -
  • Packagist
  • IRC
    • diff --git a/docs/conf.py b/docs/conf.py index 6a0269c7..895886d2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,6 +42,8 @@ htmlhelp_basename = 'Guzzledoc' # -- Guzzle Sphinx theme setup ------------------------------------------------ +sys.path.insert(0, '/Users/dowling/projects/guzzle_sphinx_theme') + import guzzle_sphinx_theme pygments_style = 'guzzle_sphinx_theme.GuzzleStyle' html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator' diff --git a/docs/docs.rst b/docs/docs.rst index abb713ad..cf87908b 100644 --- a/docs/docs.rst +++ b/docs/docs.rst @@ -1,43 +1,5 @@ .. title:: Guzzle | PHP HTTP client and framework for consuming RESTful web services -.. toctree:: - :hidden: - - getting-started/overview - getting-started/installation - - http-client/client - http-client/request - http-client/response - http-client/entity-bodies - http-client/http-redirects - - plugins/plugins-overview - plugins/creating-plugins - plugins/async-plugin - plugins/backoff-plugin - plugins/cache-plugin - plugins/cookie-plugin - plugins/curl-auth-plugin - plugins/history-plugin - plugins/log-plugin - plugins/md5-validator-plugin - plugins/mock-plugin - plugins/oauth-plugin - - webservice-client/webservice-client - webservice-client/using-the-service-builder - webservice-client/guzzle-service-descriptions - - batching/batching - - iterators/resource-iterators - iterators/guzzle-iterators - - testing/unit-testing.rst - http-client/uri-templates - getting-started/faq - ==================== Guzzle Documentation ==================== @@ -45,58 +7,67 @@ Guzzle Documentation Getting started --------------- -.. list-table:: - :header-rows: 0 - :stub-columns: 0 - :class: two-column +.. toctree:: + :maxdepth: 1 - * - :doc:`getting-started/overview` - - :doc:`getting-started/installation` - * - :doc:`getting-started/faq` - - `Read the API docs `_ + getting-started/overview + getting-started/installation + getting-started/faq The HTTP client --------------- -.. list-table:: - :header-rows: 0 - :stub-columns: 0 - :class: two-column +.. toctree:: + :maxdepth: 2 - * - :doc:`http-client/client` - - :doc:`http-client/request` - * - :doc:`http-client/response` - - :doc:`http-client/entity-bodies` - * - :doc:`http-client/http-redirects` - - :doc:`http-client/uri-templates` + http-client/client + http-client/request + http-client/response + http-client/entity-bodies + http-client/http-redirects + http-client/uri-templates Plugins ------- -.. list-table:: - :header-rows: 0 - :stub-columns: 0 - :class: two-column +.. toctree:: + :maxdepth: 1 - * - :doc:`plugins/plugins-overview` - - :doc:`plugins/creating-plugins` + plugins/plugins-overview + plugins/creating-plugins + plugins/async-plugin + plugins/backoff-plugin + plugins/cache-plugin + plugins/cookie-plugin + plugins/curl-auth-plugin + plugins/history-plugin + plugins/log-plugin + plugins/md5-validator-plugin + plugins/mock-plugin + plugins/oauth-plugin The web service client ---------------------- -.. list-table:: - :header-rows: 0 - :stub-columns: 0 - :class: two-column +.. toctree:: + :maxdepth: 1 - * - :doc:`webservice-client/webservice-client` - - :doc:`webservice-client/using-the-service-builder` - * - :doc:`webservice-client/guzzle-service-descriptions` - - :doc:`batching/batching` - * - :doc:`iterators/resource-iterators` - - :doc:`iterators/guzzle-iterators` + webservice-client/webservice-client + webservice-client/using-the-service-builder + webservice-client/guzzle-service-descriptions + batching/batching + iterators/resource-iterators + iterators/guzzle-iterators Testing ------- -* :doc:`testing/unit-testing` +.. toctree:: + :maxdepth: 2 + + testing/unit-testing + +API Docs +-------- + +`Read the API docs `_ diff --git a/docs/requirements.txt b/docs/requirements.txt index 08fe0cca..f62e3183 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,2 @@ Sphinx>=1.2b1 -guzzle_sphinx_theme>=0.4.0 +guzzle_sphinx_theme>=0.5.0