Skip to content

Commit

Permalink
Use new documentation theme based on mkdocs-material
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 375270777
Change-Id: Ie97052d1f0bcde1cbc2aec7cdd79cbb3eabdbbf8
  • Loading branch information
jbms authored and copybara-github committed May 22, 2021
1 parent 6afce54 commit 97106ae
Show file tree
Hide file tree
Showing 285 changed files with 32,822 additions and 620 deletions.
2 changes: 1 addition & 1 deletion .style.yapf
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[style]
based_on_style: chromium
based_on_style: yapf
63 changes: 63 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -228,3 +228,66 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

--------------------------------------------------------------------------------

Files: docs/tensorstore_sphinx_ext/autodoc.py

Copyright (c) 2007-2020 by the Sphinx team (see AUTHORS file).
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

--------------------------------------------------------------------------------

Files: third_party/com_google_snappy/bundled.BUILD.bazel

Copyright 2011 Google Inc. All Rights Reserved.
Author: [email protected] (Steinar H. Gunderson)

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
8 changes: 7 additions & 1 deletion WORKSPACE
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
workspace(name = "com_github_google_tensorstore")
workspace(
name = "com_github_google_tensorstore",
)

load("//:external.bzl", "tensorstore_dependencies")

tensorstore_dependencies()

register_toolchains("@local_config_python//:py_toolchain")

load("//:external2.bzl", "tensorstore_dependencies2")

tensorstore_dependencies2()
27 changes: 24 additions & 3 deletions docs/BUILD
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
load("//python/tensorstore:pytype.bzl", "pytype_strict_binary", "pytype_strict_test")
load("//python/tensorstore:pytest.bzl", "tensorstore_pytest_test")
load("@bazel_skylib//rules:common_settings.bzl", "bool_flag")

package(
default_visibility = ["//visibility:public"],
Expand All @@ -13,8 +14,6 @@ filegroup(
"conf.py",
"_templates/logo.svg",
] + glob([
"_templates/**",
"_static/**",
"**/*.rst",
"**/*.yml",
"intersphinx_inv/**",
Expand Down Expand Up @@ -52,20 +51,42 @@ genrule(
],
)

bool_flag(
name = "no_minify",
build_setting_default = False,
)

config_setting(
name = "no_minify_setting",
flag_values = {
":no_minify": "True",
},
visibility = ["//docs:__subpackages__"],
)

pytype_strict_test(
name = "build_docs",
srcs = ["build_docs.py"],
args = [
"--minify-tool=$(location //docs/tensorstore_sphinx_material:minify_html)",
] + select({
":no_minify_setting": ["--no-minify"],
"//conditions:default": [],
}),
data = [
":doc_sources",
"//docs/tensorstore_sphinx_material:minify_html",
],
python_version = "PY3",
tags = ["manual"],
deps = [
"//docs/tensorstore_sphinx_ext:autodoc",
"//docs/tensorstore_sphinx_ext:autosummary",
"//docs/tensorstore_sphinx_ext:jsonschema_sphinx",
"//docs/tensorstore_sphinx_ext:mathjax",
"//docs/tensorstore_sphinx_material",
"//python/tensorstore",
"@pypa_sphinx//:sphinx",
"@pypa_sphinx_rtd_theme//:sphinx_rtd_theme",
],
)

Expand Down
32 changes: 0 additions & 32 deletions docs/_static/sphinx_rtd_theme_table_word_wrap_fix.css

This file was deleted.

5 changes: 0 additions & 5 deletions docs/_templates/autosummary/base.rst

This file was deleted.

30 changes: 0 additions & 30 deletions docs/_templates/autosummary/class.rst

This file was deleted.

39 changes: 0 additions & 39 deletions docs/_templates/autosummary/module.rst

This file was deleted.

48 changes: 0 additions & 48 deletions docs/_templates/autosummary_root_module.rst

This file was deleted.

Loading

0 comments on commit 97106ae

Please sign in to comment.