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.

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

feat: Stage 2 of nox implementation - adding docs target #473

Merged
merged 6 commits into from Aug 29, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -14,3 +14,6 @@ django_tests

# JetBrains
.idea

# Built documentation
docs/_build
1 change: 1 addition & 0 deletions docs/README.rst
@@ -0,0 +1 @@
../README.md
c24t marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 4 additions & 0 deletions docs/_static/custom.css
@@ -0,0 +1,4 @@
div#python2-eol {
c24t marked this conversation as resolved.
Show resolved Hide resolved
border-color: red;
border-width: medium;
}
50 changes: 50 additions & 0 deletions docs/_templates/layout.html
@@ -0,0 +1,50 @@

{% extends "!layout.html" %}
{%- block content %}
{%- if theme_fixed_sidebar|lower == 'true' %}
<div class="document">
{{ sidebar() }}
{%- block document %}
<div class="documentwrapper">
{%- if render_sidebar %}
<div class="bodywrapper">
{%- endif %}

{%- block relbar_top %}
{%- if theme_show_relbar_top|tobool %}
<div class="related top">
&nbsp;
{{- rellink_markup () }}
</div>
{%- endif %}
{% endblock %}

<div class="body" role="main">
<div class="admonition" id="python2-eol">
As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
Library versions released prior to that date will continue to be available. For more information please
visit <a href="https://cloud.google.com/python/docs/python2-sunset/">Python 2 support on Google Cloud</a>.
</div>
{% block body %} {% endblock %}
</div>
c24t marked this conversation as resolved.
Show resolved Hide resolved

{%- block relbar_bottom %}
{%- if theme_show_relbar_bottom|tobool %}
<div class="related bottom">
&nbsp;
{{- rellink_markup () }}
</div>
{%- endif %}
{% endblock %}

{%- if render_sidebar %}
</div>
{%- endif %}
</div>
{%- endblock %}
<div class="clearer"></div>
</div>
{%- else %}
{{ super() }}
{%- endif %}
{%- endblock %}
4 changes: 4 additions & 0 deletions docs/api-reference.rst
@@ -0,0 +1,4 @@
API Reference
=============

[The following classes and methods constitute the Spanner DB API connection.]
c24t marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions docs/changelog.md
@@ -0,0 +1 @@
# Changelog