-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat(docs): publish Client libraries help to python reference documen… #16575
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "name": "help", | ||
| "name_pretty": "Client libraries help", | ||
| "client_documentation": "https://cloud.google.com/python/docs/reference/help/latest", | ||
| "language": "python", | ||
| "library_type": "OTHER", | ||
| "repo": "googleapis/google-cloud-python", | ||
| "distribution_name": "help", | ||
| "codeowner_team": "@googleapis/cloud-sdk-python-team" | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Google Cloud Python Help | ||
|
|
||
| Client libraries help documentation for common support issues and general information. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import os | ||
| import pathlib | ||
| import shutil | ||
| import sys | ||
| import yaml | ||
| import pypandoc | ||
|
|
||
| def build_docfx(current_dir, repo_root, docs_map): | ||
| current_dir = pathlib.Path(current_dir) | ||
| repo_root = pathlib.Path(repo_root) | ||
bshaffer marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| output_dir = current_dir / "docs" / "_build" | ||
|
|
||
| if output_dir.exists(): | ||
| shutil.rmtree(output_dir) | ||
| output_dir.mkdir(parents=True) | ||
|
|
||
| # Ensure pandoc is available (pypandoc will download it if not found in PATH) | ||
| try: | ||
| pypandoc.get_pandoc_version() | ||
| except OSError: | ||
| print("Pandoc not found. Downloading...") | ||
| pypandoc.download_pandoc() | ||
|
|
||
| toc = [] | ||
|
|
||
| for title, source in docs_map.items(): | ||
| source_path = pathlib.Path(source) | ||
| if not source_path.is_absolute(): | ||
| source_path = current_dir / source_path | ||
|
|
||
| filename = source_path.name | ||
|
|
||
| if filename.endswith(".rst"): | ||
| target_filename = filename.replace(".rst", ".md") | ||
| print(f"Converting {filename} -> {target_filename} using pandoc") | ||
| if source_path.exists(): | ||
| # Use pandoc to convert RST to GFM (GitHub Flavored Markdown) | ||
| output = pypandoc.convert_file( | ||
| str(source_path), | ||
| 'gfm', | ||
| format='rst' | ||
| ) | ||
| (output_dir / target_filename).write_text(output) | ||
bshaffer marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| else: | ||
| print(f"Warning: Source {source_path} not found.") | ||
| (output_dir / target_filename).write_text(f"# {title}\n\nContent missing.") | ||
| href = target_filename | ||
| else: | ||
| print(f"Copying {filename}") | ||
| if source_path.exists(): | ||
| shutil.copy(source_path, output_dir / filename) | ||
| else: | ||
| print(f"Warning: Source {source_path} not found.") | ||
| (output_dir / filename).write_text(f"# {title}\n\nContent missing.") | ||
| href = filename | ||
|
|
||
| toc.append({"name": title, "href": href}) | ||
|
|
||
| # Write toc.yaml | ||
| toc_path = output_dir / "toc.yaml" | ||
| with open(toc_path, "w") as f: | ||
| yaml.dump(toc, f, default_flow_style=False) | ||
bshaffer marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| print(f"DocFX build complete in {output_dir}") | ||
| print(f"Generated TOC: {toc}") | ||
|
|
||
| if __name__ == "__main__": | ||
| # Simple argument parsing: current_dir, repo_root, then pairs of Title,Source | ||
| curr = sys.argv[1] | ||
| root = sys.argv[2] | ||
| d_map = {} | ||
| for i in range(3, len(sys.argv), 2): | ||
| d_map[sys.argv[i]] = sys.argv[i+1] | ||
bshaffer marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| build_docfx(curr, root, d_map) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Copyright 2022 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| __version__ = "1.0.0" | ||
|
|
||
| # {x-release-please-start-date} | ||
| __release_date__ = "2026-04-07" | ||
| # {x-release-please-end} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # -*- coding: utf-8 -*- | ||
| # | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software/ | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from __future__ import absolute_import | ||
bshaffer marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| import pathlib | ||
| import nox | ||
|
|
||
| DEFAULT_PYTHON_VERSION = "3.14" | ||
| CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() | ||
| REPO_ROOT = CURRENT_DIRECTORY.parent.parent | ||
|
|
||
| # Hardcoded dictionary of documentation files. | ||
| # Format: {"Display Title": "filename.md" or absolute path} | ||
| DOCS_MAP = { | ||
| "Getting started": str(REPO_ROOT / "README.rst"), | ||
| } | ||
|
|
||
| nox.options.sessions = [ | ||
| "lint", | ||
| "docfx", | ||
| ] | ||
|
|
||
| # Error if a python version is missing | ||
| nox.options.error_on_missing_interpreters = True | ||
|
|
||
| @nox.session(python=DEFAULT_PYTHON_VERSION) | ||
| def lint(session): | ||
| """Run linters.""" | ||
| session.install("ruff") | ||
| session.run("ruff", "check", ".") | ||
|
|
||
| @nox.session(python="3.10") | ||
| def docfx(session): | ||
| """Build the docfx yaml files for this library.""" | ||
| session.install("PyYAML", "pypandoc") | ||
|
|
||
| # Construct arguments for the helper script | ||
| args = [str(CURRENT_DIRECTORY), str(REPO_ROOT)] | ||
| for title, source in DOCS_MAP.items(): | ||
| args.extend([title, str(source)]) | ||
|
|
||
| session.run("python", "docfx_helper.py", *args) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
|
|
||
| import io | ||
| import os | ||
|
|
||
| import setuptools | ||
|
|
||
| # Package metadata. | ||
|
|
||
| name = "help" | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. IMO, we should avoid creating a new package which is only used for documentation purposes. It could be helpful to have a quick offline discussion/doc to help reviewers get up to speed. |
||
| description = "Client libraries help documentation" | ||
| release_status = "Development Status :: 5 - Production/Stable" | ||
| dependencies = [] | ||
|
|
||
| # Setup boilerplate below this line. | ||
|
|
||
| package_root = os.path.abspath(os.path.dirname(__file__)) | ||
|
|
||
| readme_filename = os.path.join(package_root, "README.md") | ||
| with io.open(readme_filename, encoding="utf-8") as readme_file: | ||
| readme = readme_file.read() | ||
|
|
||
| version = {} | ||
| with open(os.path.join(package_root, "help/version.py")) as fp: | ||
| exec(fp.read(), version) | ||
| version_id = version["__version__"] | ||
|
|
||
| setuptools.setup( | ||
| name=name, | ||
| version=version_id, | ||
| description=description, | ||
| long_description=readme, | ||
| long_description_content_type="text/markdown", | ||
| author="Google LLC", | ||
| author_email="cloud-sdk@google.com", | ||
| license="Apache 2.0", | ||
| url="https://github.com/googleapis/google-cloud-python/tree/main/packages/help", | ||
| project_urls={ | ||
| "Source": "https://github.com/googleapis/google-cloud-python/tree/main/packages/help", | ||
| "Changelog": "https://github.com/googleapis/google-cloud-python/tree/main/packages/help/CHANGELOG.md", | ||
| "Issues": "https://github.com/googleapis/google-cloud-python/issues", | ||
| }, | ||
| classifiers=[ | ||
| release_status, | ||
| "Intended Audience :: Developers", | ||
| "Programming Language :: Python", | ||
| "Programming Language :: Python :: 3", | ||
| "Programming Language :: Python :: 3.10", | ||
| "Programming Language :: Python :: 3.11", | ||
| "Programming Language :: Python :: 3.12", | ||
| "Programming Language :: Python :: 3.13", | ||
| "Programming Language :: Python :: 3.14", | ||
| "Operating System :: OS Independent", | ||
| "Topic :: Internet", | ||
| ], | ||
| install_requires=dependencies, | ||
| python_requires=">=3.10", | ||
| include_package_data=True, | ||
| zip_safe=False, | ||
| packages=["help"], | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'll wait to hear the opinion of a repo maintainer before changing this. Happy to rename it to whatever. |
||
| ) | ||
Uh oh!
There was an error while loading. Please reload this page.