-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Docs: prepare for repo split #5912
Copy link
Copy link
Closed
Labels
api: bigqueryIssues related to the BigQuery API.Issues related to the BigQuery API.api: bigtableIssues related to the Bigtable API.Issues related to the Bigtable API.api: clouderrorreportingIssues related to the Error Reporting API.Issues related to the Error Reporting API.api: cloudresourcemanagerIssues related to the Resource Manager API.Issues related to the Resource Manager API.api: cloudtraceIssues related to the Cloud Trace API.Issues related to the Cloud Trace API.api: coreapi: datastoreIssues related to the Datastore API.Issues related to the Datastore API.api: dnsIssues related to the Cloud DNS API.Issues related to the Cloud DNS API.api: firestoreIssues related to the Firestore API.Issues related to the Firestore API.api: languageIssues related to the Cloud Natural Language API API.Issues related to the Cloud Natural Language API API.api: loggingIssues related to the Cloud Logging API.Issues related to the Cloud Logging API.api: pubsubIssues related to the Pub/Sub API.Issues related to the Pub/Sub API.api: runtimeconfigIssues related to the Cloud Runtime Config API API.Issues related to the Cloud Runtime Config API API.api: spannerIssues related to the Spanner API.Issues related to the Spanner API.api: speechIssues related to the Speech-to-Text API.Issues related to the Speech-to-Text API.api: storageIssues related to the Cloud Storage API.Issues related to the Cloud Storage API.api: translationIssues related to the Cloud Translation API API.Issues related to the Cloud Translation API API.type: docsImprovement to the documentation for an API.Improvement to the documentation for an API.
Metadata
Metadata
Assignees
Labels
api: bigqueryIssues related to the BigQuery API.Issues related to the BigQuery API.api: bigtableIssues related to the Bigtable API.Issues related to the Bigtable API.api: clouderrorreportingIssues related to the Error Reporting API.Issues related to the Error Reporting API.api: cloudresourcemanagerIssues related to the Resource Manager API.Issues related to the Resource Manager API.api: cloudtraceIssues related to the Cloud Trace API.Issues related to the Cloud Trace API.api: coreapi: datastoreIssues related to the Datastore API.Issues related to the Datastore API.api: dnsIssues related to the Cloud DNS API.Issues related to the Cloud DNS API.api: firestoreIssues related to the Firestore API.Issues related to the Firestore API.api: languageIssues related to the Cloud Natural Language API API.Issues related to the Cloud Natural Language API API.api: loggingIssues related to the Cloud Logging API.Issues related to the Cloud Logging API.api: pubsubIssues related to the Pub/Sub API.Issues related to the Pub/Sub API.api: runtimeconfigIssues related to the Cloud Runtime Config API API.Issues related to the Cloud Runtime Config API API.api: spannerIssues related to the Spanner API.Issues related to the Spanner API.api: speechIssues related to the Speech-to-Text API.Issues related to the Speech-to-Text API.api: storageIssues related to the Cloud Storage API.Issues related to the Cloud Storage API.api: translationIssues related to the Cloud Translation API API.Issues related to the Cloud Translation API API.type: docsImprovement to the documentation for an API.Improvement to the documentation for an API.
/cc @theacodes FYR.
Because the "documentation root" changes for inclusions between the monorepo docs build and the per-package docs build, we have to do this in two phases.
Steps before the split:
docs/tree, move their contents to that directory and set up symlinks. Test that top-level docs still generate correctly via symlinks.README.rstwith thedocs/index.rstlanding page (see PR Docs: Replace links to '/stable/' with '/latest/'. #5901 / commit 26efddf for recently-generated packages).usage.rst->index.rst), leave behind a redirect page (seebigquery/docs/usage.html) and link it indocs/conf.py.README.rst/docs/index.rstfromsynth.py.GA packages:
Beta packages:
Alpha packages:
Not-yet-released packages:
After the split:
docs/conf.pyto all packages which don't have it (fix up bitrot for those which do).nox -e docstarget for all packages and test.docs/conf.pywith localdocs/conf.py.