Skip to content

Fix some doc build warnings #184

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

Merged
merged 1 commit into from
Aug 25, 2025
Merged

Fix some doc build warnings #184

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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
venv
docs/venv

# Ignores CPython checkout
cpython
18 changes: 11 additions & 7 deletions docs/bumping-release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
====================================================
:orphan:

==============================================
Bumping python-newest to latest Python release
====================================================
==============================================

.. warning::

NOTE: This doc is out of date and needs rework! The
`pull request \#13 <https://github.com/python-docs-translations/transifex-automations/pull/13>`_
is a work in progress that would change some instructions from this guide.
This doc is out of date and needs rework! The
`pull request \#13 <https://github.com/python-docs-translations/transifex-automations/pull/13>`_
is a work in progress that would change some instructions from this guide.

This document aims to list the steps required for updating version of the 'Python'
project (slug 'python-newest) in python-doc organization in Transifex.
This document aims to list the steps required for bumping the version of the
'Python' project (slug 'python-newest) in the python-doc organization on Transifex.

1. Back up current translations:

Expand Down
1 change: 1 addition & 0 deletions docs/commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ For language teams that coordinate translation efforts on Transifex, updating
translation means pulling the translation strings.

.. admonition:: Recommendation

Before pulling translations, consider updating the .tx/config to
have an up-to-date mapping of project/resources. For this, it is required to
generate the documentation's pot files (template of po files), so start
Expand Down
10 changes: 5 additions & 5 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,22 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "Python Docs Transifex Automations"
copyright = "2025, rffontenelle"
author = "rffontenelle"
copyright = "2025, rffontenelle and StanFromIreland"
author = "rffontenelle and StanFromIreland"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []

templates_path = ["_templates"]
exclude_patterns = []
templates_path = []
exclude_patterns = ["venv", ".venv"]

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "furo"
html_static_path = ["_static"]
html_static_path = []
html_title = "Python Docs Transifex Automations"

# ----------------------------------------------------------------------------
Expand Down