Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit a816ab9

Browse filesBrowse files
vi3k6i5vi3k6i5
committed
feat: added docfx build in nox file
1 parent ecb0eec commit a816ab9
Copy full SHA for a816ab9

File tree

Expand file treeCollapse file tree

7 files changed

+44
-9
lines changed
Filter options
Expand file treeCollapse file tree

7 files changed

+44
-9
lines changed

‎docs/_static/custom.css

Copy file name to clipboard
+9Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
div#python2-eol {
2+
border-color: red;
3+
border-width: medium;
4+
}
5+
6+
/* Ensure minimum width for 'Parameters' / 'Returns' column */
7+
dl.field-list > dt {
8+
min-width: 100px
9+
}

‎docs/api-reference.rst

Copy file name to clipboardExpand all lines: docs/api-reference.rst
+4-1Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,7 @@ API Reference
33

44
The following classes and methods constitute the Django Spanner API.
55

6-
[this page is under construction]
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
schema-api

‎docs/conf.py

Copy file name to clipboardExpand all lines: docs/conf.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@
173173
# Add any paths that contain custom static files (such as style sheets) here,
174174
# relative to this directory. They are copied after the builtin static files,
175175
# so a file named "default.css" will overwrite the builtin "default.css".
176-
# html_static_path = ["_static"]
176+
html_static_path = ["_static"]
177177

178178
# Add any extra paths that contain custom files (such as robots.txt or
179179
# .htaccess) here, relative to this directory. These files are copied

‎docs/index.rst

Copy file name to clipboardExpand all lines: docs/index.rst
+8Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
.. include:: README.rst
22

3+
Usage Documentation
4+
-------------------
5+
.. toctree::
6+
:maxdepth: 1
7+
:titlesonly:
8+
9+
schema-usage
10+
311
API Documentation
412
-----------------
513
.. toctree::

‎docs/schema-api.rst

Copy file name to clipboard
+8Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Schema API
2+
=====================
3+
4+
.. automodule:: django_spanner.schema
5+
:members:
6+
:inherited-members:
7+
8+

‎docs/schema-usage.rst

Copy file name to clipboard
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Schema
2+
####################################
3+
4+
[this page is under construction]

‎noxfile.py

Copy file name to clipboardExpand all lines: noxfile.py
+10-7Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def default(session):
7979
"--cov-append",
8080
"--cov-config=.coveragerc",
8181
"--cov-report=",
82-
"--cov-fail-under=20",
82+
"--cov-fail-under=25",
8383
os.path.join("tests", "unit"),
8484
*session.posargs
8585
)
@@ -109,12 +109,13 @@ def docs(session):
109109
"""Build the docs for this library."""
110110

111111
session.install("-e", ".[tracing]")
112-
session.install("sphinx", "alabaster", "recommonmark")
112+
session.install("sphinx", "alabaster", "recommonmark", "django==2.2")
113113

114114
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
115+
# Warnings as errors is disabled for `sphinx-build` because django module
116+
# has warnings.
115117
session.run(
116118
"sphinx-build",
117-
"-W", # warnings as errors
118119
"-T", # show full traceback on exception
119120
"-N", # no colors
120121
"-b",
@@ -130,11 +131,13 @@ def docs(session):
130131
def docfx(session):
131132
"""Build the docfx yaml files for this library."""
132133

133-
session.install("-e", ".[tracing]")
134-
# sphinx-docfx-yaml supports up to sphinx version 1.5.5.
135-
# https://github.com/docascode/sphinx-docfx-yaml/issues/97
134+
session.install("-e", ".")
136135
session.install(
137-
"sphinx==1.5.5", "alabaster", "recommonmark", "sphinx-docfx-yaml"
136+
"sphinx",
137+
"alabaster",
138+
"recommonmark",
139+
"sphinx-docfx-yaml",
140+
"django==2.2",
138141
)
139142

140143
shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.