guzzle / guzzle_sphinx_theme Goto Github PK

View Code? Open in Web Editor NEW

168.0 168.0 60.0 2.54 MB

Sphinx theme used by Guzzle

License: MIT License

Python 14.61% HTML 65.95% CSS 19.44%

guzzle_sphinx_theme's Introduction

Guzzle, PHP HTTP client

Guzzle is a PHP HTTP client that makes it easy to send HTTP requests and trivial to integrate with web services.

Simple interface for building query strings, POST requests, streaming large uploads, streaming large downloads, using HTTP cookies, uploading JSON data, etc...
Can send both synchronous and asynchronous requests using the same interface.
Uses PSR-7 interfaces for requests, responses, and streams. This allows you to utilize other PSR-7 compatible libraries with Guzzle.
Supports PSR-18 allowing interoperability between other PSR-18 HTTP Clients.
Abstracts away the underlying HTTP transport, allowing you to write environment and transport agnostic code; i.e., no hard dependency on cURL, PHP streams, sockets, or non-blocking event loops.
Middleware system allows you to augment and compose client behavior.

$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.github.com/repos/guzzle/guzzle');

echo $response->getStatusCode(); // 200
echo $response->getHeaderLine('content-type'); // 'application/json; charset=utf8'
echo $response->getBody(); // '{"id": 1420053, "name": "guzzle", ...}'

// Send an asynchronous request.
$request = new \GuzzleHttp\Psr7\Request('GET', 'http://httpbin.org');
$promise = $client->sendAsync($request)->then(function ($response) {
    echo 'I completed! ' . $response->getBody();
});

$promise->wait();

Help and docs

We use GitHub issues only to discuss bugs and new features. For support please refer to:

Installing Guzzle

The recommended way to install Guzzle is through Composer.

composer require guzzlehttp/guzzle

Version Guidance

Version	Status	Packagist	Namespace	Repo	Docs	PSR-7	PHP Version
3.x	EOL (2016-10-31)	`guzzle/guzzle`	`Guzzle`	v3	v3	No	>=5.3.3,<7.0
4.x	EOL (2016-10-31)	`guzzlehttp/guzzle`	`GuzzleHttp`	v4	N/A	No	>=5.4,<7.0
5.x	EOL (2019-10-31)	`guzzlehttp/guzzle`	`GuzzleHttp`	v5	v5	No	>=5.4,<7.4
6.x	EOL (2023-10-31)	`guzzlehttp/guzzle`	`GuzzleHttp`	v6	v6	Yes	>=5.5,<8.0
7.x	Latest	`guzzlehttp/guzzle`	`GuzzleHttp`	v7	v7	Yes	>=7.2.5,<8.4

Security

If you discover a security vulnerability within this package, please send an email to [email protected]. All security vulnerabilities will be promptly addressed. Please do not disclose security-related issues publicly until a fix has been announced. Please see Security Policy for more information.

License

Guzzle is made available under the MIT License (MIT). Please see License File for more information.

For Enterprise

Available as part of the Tidelift Subscription

The maintainers of Guzzle and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

guzzle_sphinx_theme's People

Contributors

Stargazers

Watchers

guzzle_sphinx_theme's Issues

Multiple toctrees with captions

I write a "big" documentation that covers multiple components.
In the main index.rst multiple toctrees are used like this:

.. toctree::
   :name: toc_index
   :maxdepth: 1

   root/page1
   root/page2
   root/page3

.. toctree::
   :caption: Component A
   :name: toc_component_a
   :maxdepth: 1

   compA/page1
   compA/page2
   compA/page3

.. toctree::
   :caption: Component B
   :name: toc_component_b
   :maxdepth: 1

   compB/page1
   compB/page2
   compB/page3

The captions in navigation are not styled properly.
I've added a custom css for these captions:

div.sphinxsidebar .sidebar-toc .caption {
    margin: 17px 0 0 0;
    padding: 0 22px 6px;
    font-size: 14px;
    font-weight: bold;
    color: #606060;
}

Table rendering

Hi!

I am happily creating documentation using guzzle_sphinx_theme!

I just have an issue about the rendering of the tables. Do you have any suggestions on how my table is rendered like this:

instead of like this:

All the other renderings work fine.
Thanks a lot for your kind help!

Sidebar table of contents with 3 levels

Hi!

This is a beautiful theme, thanks a lot for making this easily available.

My only complaint is that it would be nice to get three levels of depth in the sidebar table of contents. At the momment, it only show sections and subsections, but it would be nice if there was a way to make subsubsections reachable from there. The read the docs theme supports this feature.

Otherwise, could you maybe hint me at how could I achieve this feature via custom layouts?

Thanks!

GuzzleStyle class no longer exists, but referenced in README

Looks like this was removed in 4016163#diff-a7f4d21fc33cf48ebda65da9685c7a04

The readme still has the line:

pygments_style = 'guzzle_sphinx_theme.GuzzleStyle'

Add back support for the sidebar by default

I noticed when I upgraded to the latest theme (I was coming from a really old 0.3.x release) that the sidebar is no longer displayed by default.

For example, if I build an empty sphinx project using their built in theme I get:

When I used version 0.3.x of this project I get:

But if I pip install --upgrade guzzle_sphinx_theme the default is now:

To get the sidebar back I had to add:

html_sidebars = {
    '**': ['logo-text.html', 'globaltoc.html', 'searchbox.html']
}

which then gives me what I was looking for:

It would be great to either:

Add back support for showing the sidebar by default like in the built in sphinx theme and v0.3.x of this theme (my preference)
Document how people can get the sidebar added if the want it.

New tag?

Can you bump up to 0.7 so we can install the current version via pip?

Image width larger than expected

The guzzle theme is not expecting images larger than the content.

A simple fix to guzzle.css_t would be something like:

.container-wrapper img {
    width: 100%;
}

Using theme with githubpages/readthedocs

I can only get the theme to work locally. If I use make html it works properly, using automated tools like githubpages or readthedocs however, the documentation is broken.

How do I properly use it? I don't want an unnecessary dependency in my python project, thus it is not included in requirements.txt or setup.py. Instead, I just put a zip file in docs/source which works perfectly local, but not using a service.
What is a proper way use this theme?

Is there a way to customise the css?

Hi all. Thanks for the lovely theme!

Is there a way to customise/tweak the css? I'd like to add a border above the first method in every class (so that it's more clear where the class description ends and the method descriptions start)

Toctree refreshes and jumps

HI!
The Toctree on the left， always refreshes and jumps to the top when clicked on the two level title.
I want to fix the Toctree so that it doesn't jump. Is there any good way? Thank you！

sidebar not properly indented

I installed the theme and successfully implemented it as described in the readme, but my sidebar is not padded properly?

See below

Have I done something wrong, or is there a CSS error? This problem is prevent in firefox 58 as well as chrome 63. I didn't try other browsers.

Deprecation warning about javascript

Hi,

I am getting deprecation warnings about javascript:

venv/lib/python3.7/site-packages/guzzle_sphinx_theme/guzzle_sphinx_theme/layout.html:198: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a <script> tag directly in your theme instead.

Sphinx version 2.0.1
Guzzle theme version 0.7.11

Example should be extrahead

Example in ReadMe should use the wrong block name, should be extrahead not extra_head

New release

Hi,

Thanks a lot for this beautiful and legible theme.

Could you please release a new version? A released fix for #23 in PyPI would be great.

Thanks.

Release includes .DS_Store files

The release tarball on pypi includes .DS_Store files which shouldn't be there.
Could they be excluded?

Breadcrumbs are covered on small screens

The breadcrumbs are covered up by the sticky nave bar on small screens.

The sidebar is missing

When I apply the theme, the sidebar of the site is missing. (I set only the parameter "project_nav_name").
How could I fix this problem? Thank you!

How to make spaces ?

Hello, for the theme on your website http://docs.guzzlephp.org/en/stable/ , i saw you spaced the entries of the 'table of contents'. When i use the template, my entries are on the verry left of my screen(http://www.bilder-upload.eu/show.php?file=2c4e13-1504730710.png)
How do i add spaces there ?

math has colors

Hi,
When using :math:, chars get green. What should I overwrite in css to have black chars?
Thanks a lot!

Table of contents sidebar broken in Sphinx 1.7

As of Sphinx 1.7, the styling of the sidebar is rather broken as some of the elements have moved around (e.g. sidebar-localtoc has been renamed to sidebar-toc). The mobile layout shows similar issues.

Basic config file and index page

import guzzle_sphinx_theme


templates_path = ["_templates"]
exclude_patterns = ["_build"]

master_doc = "index"

project = "Test"
author = "Author"
copyright = "2018, {}".format(author)

html_theme = "guzzle_sphinx_theme"
html_theme_path = guzzle_sphinx_theme.html_theme_path()

html_title = project

Index
=====

.. toctree::
    self
    page

Subheading 1
------------

Some text.

Subheading 2
------------

Some more text.

Output from 1.6.6

Output from 1.7.0

README contains theme options that are no longer supported

I upgrade to the latest guzzle_sphinx_theme and noticed that several of the theme options (project_nav_name, github user/repos, etc) are no longer supported, but are still documented in the README. It would be great to get the README updated with an updated list of theme options.