Skip to content

chore: remove code formatting for docs/conf.py #2493

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: remove-formatting-setup-py
Choose a base branch
from
Open

chore: remove code formatting for docs/conf.py #2493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions gapic/templates/docs/conf.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ source_suffix = [".rst", ".md"]
root_doc = "index"

# General information about the project.
project = u"{{ api.naming.warehouse_package_name }}"
copyright = u"2025, Google, LLC"
author = u"Google APIs"
project = "{{ api.naming.warehouse_package_name }}"
copyright = "2025, Google, LLC"
author = "Google APIs"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -272,7 +272,7 @@ latex_documents = [
(
root_doc,
"{{ api.naming.warehouse_package_name }}.tex",
u"{{ api.naming.warehouse_package_name }} Documentation",
"{{ api.naming.warehouse_package_name }} Documentation",
author,
"manual",
)
Expand Down
4 changes: 2 additions & 2 deletions gapic/templates/noxfile.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ BLACK_VERSION = "black[jupyter]==23.7.0"
ISORT_VERSION = "isort==5.11.0"

{% if api.naming.module_namespace %}
FORMAT_PATHS = ["docs", "{{ api.naming.module_namespace[0] }}", "tests"]
FORMAT_PATHS = ["{{ api.naming.module_namespace[0] }}", "tests"]
LINT_PATHS = ["docs", "{{ api.naming.module_namespace[0] }}", "tests", "noxfile.py", "setup.py"]
{% else %}
FORMAT_PATHS = ["docs", "{{ api.naming.versioned_module_name }}", "tests"]
FORMAT_PATHS = ["{{ api.naming.versioned_module_name }}", "tests"]
LINT_PATHS = ["docs", "{{ api.naming.versioned_module_name }}", "tests", "noxfile.py", "setup.py"]
{% endif %}

Expand Down
8 changes: 4 additions & 4 deletions tests/integration/goldens/asset/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@
root_doc = "index"

# General information about the project.
project = u"google-cloud-asset"
copyright = u"2025, Google, LLC"
author = u"Google APIs"
project = "google-cloud-asset"
copyright = "2025, Google, LLC"
author = "Google APIs"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -283,7 +283,7 @@
(
root_doc,
"google-cloud-asset.tex",
u"google-cloud-asset Documentation",
"google-cloud-asset Documentation",
author,
"manual",
)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/goldens/asset/noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
BLACK_VERSION = "black[jupyter]==23.7.0"
ISORT_VERSION = "isort==5.11.0"

FORMAT_PATHS = ["docs", "google", "tests"]
FORMAT_PATHS = ["google", "tests"]
LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]

# We're most interested in ensuring that code is formatted properly
Expand Down
8 changes: 4 additions & 4 deletions tests/integration/goldens/credentials/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@
root_doc = "index"

# General information about the project.
project = u"google-iam-credentials"
copyright = u"2025, Google, LLC"
author = u"Google APIs"
project = "google-iam-credentials"
copyright = "2025, Google, LLC"
author = "Google APIs"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -283,7 +283,7 @@
(
root_doc,
"google-iam-credentials.tex",
u"google-iam-credentials Documentation",
"google-iam-credentials Documentation",
author,
"manual",
)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/goldens/credentials/noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
BLACK_VERSION = "black[jupyter]==23.7.0"
ISORT_VERSION = "isort==5.11.0"

FORMAT_PATHS = ["docs", "google", "tests"]
FORMAT_PATHS = ["google", "tests"]
LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]

# We're most interested in ensuring that code is formatted properly
Expand Down
8 changes: 4 additions & 4 deletions tests/integration/goldens/eventarc/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@
root_doc = "index"

# General information about the project.
project = u"google-cloud-eventarc"
copyright = u"2025, Google, LLC"
author = u"Google APIs"
project = "google-cloud-eventarc"
copyright = "2025, Google, LLC"
author = "Google APIs"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -283,7 +283,7 @@
(
root_doc,
"google-cloud-eventarc.tex",
u"google-cloud-eventarc Documentation",
"google-cloud-eventarc Documentation",
author,
"manual",
)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/goldens/eventarc/noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
BLACK_VERSION = "black[jupyter]==23.7.0"
ISORT_VERSION = "isort==5.11.0"

FORMAT_PATHS = ["docs", "google", "tests"]
FORMAT_PATHS = ["google", "tests"]
LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]

# We're most interested in ensuring that code is formatted properly
Expand Down
8 changes: 4 additions & 4 deletions tests/integration/goldens/logging/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@
root_doc = "index"

# General information about the project.
project = u"google-cloud-logging"
copyright = u"2025, Google, LLC"
author = u"Google APIs"
project = "google-cloud-logging"
copyright = "2025, Google, LLC"
author = "Google APIs"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -283,7 +283,7 @@
(
root_doc,
"google-cloud-logging.tex",
u"google-cloud-logging Documentation",
"google-cloud-logging Documentation",
author,
"manual",
)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/goldens/logging/noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
BLACK_VERSION = "black[jupyter]==23.7.0"
ISORT_VERSION = "isort==5.11.0"

FORMAT_PATHS = ["docs", "google", "tests"]
FORMAT_PATHS = ["google", "tests"]
LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]

# We're most interested in ensuring that code is formatted properly
Expand Down
8 changes: 4 additions & 4 deletions tests/integration/goldens/logging_internal/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@
root_doc = "index"

# General information about the project.
project = u"google-cloud-logging"
copyright = u"2025, Google, LLC"
author = u"Google APIs"
project = "google-cloud-logging"
copyright = "2025, Google, LLC"
author = "Google APIs"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -283,7 +283,7 @@
(
root_doc,
"google-cloud-logging.tex",
u"google-cloud-logging Documentation",
"google-cloud-logging Documentation",
author,
"manual",
)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/goldens/logging_internal/noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
BLACK_VERSION = "black[jupyter]==23.7.0"
ISORT_VERSION = "isort==5.11.0"

FORMAT_PATHS = ["docs", "google", "tests"]
FORMAT_PATHS = ["google", "tests"]
LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]

# We're most interested in ensuring that code is formatted properly
Expand Down
8 changes: 4 additions & 4 deletions tests/integration/goldens/redis/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@
root_doc = "index"

# General information about the project.
project = u"google-cloud-redis"
copyright = u"2025, Google, LLC"
author = u"Google APIs"
project = "google-cloud-redis"
copyright = "2025, Google, LLC"
author = "Google APIs"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -283,7 +283,7 @@
(
root_doc,
"google-cloud-redis.tex",
u"google-cloud-redis Documentation",
"google-cloud-redis Documentation",
author,
"manual",
)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/goldens/redis/noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
BLACK_VERSION = "black[jupyter]==23.7.0"
ISORT_VERSION = "isort==5.11.0"

FORMAT_PATHS = ["docs", "google", "tests"]
FORMAT_PATHS = ["google", "tests"]
LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]

# We're most interested in ensuring that code is formatted properly
Expand Down
8 changes: 4 additions & 4 deletions tests/integration/goldens/redis_selective/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@
root_doc = "index"

# General information about the project.
project = u"google-cloud-redis"
copyright = u"2025, Google, LLC"
author = u"Google APIs"
project = "google-cloud-redis"
copyright = "2025, Google, LLC"
author = "Google APIs"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -283,7 +283,7 @@
(
root_doc,
"google-cloud-redis.tex",
u"google-cloud-redis Documentation",
"google-cloud-redis Documentation",
author,
"manual",
)
Expand Down
2 changes: 1 addition & 1 deletion tests/integration/goldens/redis_selective/noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
BLACK_VERSION = "black[jupyter]==23.7.0"
ISORT_VERSION = "isort==5.11.0"

FORMAT_PATHS = ["docs", "google", "tests"]
FORMAT_PATHS = ["google", "tests"]
LINT_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"]

# We're most interested in ensuring that code is formatted properly
Expand Down
Loading