Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs Revamp #64

Merged
merged 5 commits into from
Apr 24, 2015
Merged

Docs Revamp #64

merged 5 commits into from
Apr 24, 2015

Commits on Apr 24, 2015

  1. Structural Revamp 

    This commit revamps the general structure of the documentation,
focusing on more human-readable sections with actual descriptions,
and class grouping.

It also switches to the ReadTheDocs theme.
    @DirectXMan12
    DirectXMan12 committed Apr 24, 2015
    Configuration menu
    Copy the full SHA
    b5b8f38 View commit details
    Browse the repository at this point in the history

  2. Actually import set_encoding into the main module 

    Previously, `set_encoding` was only available from
`gssapi._utils`.  However, `gssapi._utils` was not
intended for external use, while `set_encoding` is
intended for external use.

Now, `set_encoding` is available from the main
`gssapi` module.
    @DirectXMan12
    DirectXMan12 committed Apr 24, 2015
    Configuration menu
    Copy the full SHA
    693c8f0 View commit details
    Browse the repository at this point in the history

  3. High-Level Documentation Updates 

    This commit updates the high-level documentation.  Typos were
corrected, improvements were made for readability, and more
links were inserted.

Additionally, two custom Sphinx extensions were added to help
with the process:

The first extension catches unknown class references and attempts
to track them down.  The class is searched for as if it were an
`:any:` reference.  The results from this searched are used, prefering
results in the current API level (high-level vs low-level).

The second extension adds a convinience role, `:requires-ext`, which
inserts a link and some text indicating that a particular extension
is required.  If the extension is an RFC, a link to the RFC is
generated, otherwise, a link to the low-level API module is generated.
In the latter case, the text of the link is generated using the first
line of the docstring of the low-level module, if it is present.
Otherwise, the partial name of the module is used (the '%s' part
of 'ext_%s')

Finally, as per above, the docstrings of several extensions were
updated.
    @DirectXMan12
    DirectXMan12 committed Apr 24, 2015
    Configuration menu
    Copy the full SHA
    c758fd4 View commit details
    Browse the repository at this point in the history

  4. Low-level Documentation Updates 

    This commit updates the low-level documentation, introducing method
signatures as well as fixing typos.
    @DirectXMan12
    DirectXMan12 committed Apr 24, 2015
    Configuration menu
    Copy the full SHA
    2572d5d View commit details
    Browse the repository at this point in the history

  5. Add inline documentation for low-level module 

    This commit adds a docstring to `gssapi.raw` so that
`help(gssapi.raw)` returns useful information.
    @DirectXMan12
    DirectXMan12 committed Apr 24, 2015
    Configuration menu
    Copy the full SHA
    4052a46 View commit details
    Browse the repository at this point in the history