Skip to content

Commit

Permalink
Remove note on tricky build from README.rst
Browse files Browse the repository at this point in the history
.readthedocs.yml simplified in a way that it is no longer true.
  • Loading branch information
rffontenelle authored Sep 6, 2024
1 parent ac643e9 commit 727fdae
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,14 @@ Sphinx official documentation translations

.. |main| image:: https://github.com/sphinx-doc/sphinx-doc-translations/actions/workflows/main.yml/badge.svg
:target: https://github.com/sphinx-doc/sphinx-doc-translations/actions/workflows/main.yml
:alt: Update status badge
:alt: Badge for the update status

.. |test| image:: https://github.com/sphinx-doc/sphinx-doc-translations/actions/workflows/test-translations.yml/badge.svg
:target: https://github.com/sphinx-doc/sphinx-doc-translations/actions/workflows/test-translations.yml
:alt: Test translations badge
:alt: Badge for the translation tests

This is a project to provide Sphinx official documentation, hosted on the Read The Docs platform, in multiple languages.

.. note:: The current procedure is bit tricky because Read The Docs doesn't have a way to specify options for ``sphinx-build`` command.
**conf.py** files for each languages have ``language`` and ``locale_dirs`` values without having full copy of **conf.py** of sphinx doc.
If we want to specify **conf.py** file that is out of source directory, we will use ``-c`` option for the ``sphinx-build`` command.
Unfortunately Read the Docs doesn't support that. If there is a better way, open an issue.

How the translated documentation projects are setup on RTD
----------------------------------------------------------

Expand Down

0 comments on commit 727fdae

Please sign in to comment.