search

sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.61k stars 2.13k forks source link

Use default locale_dirs value #13079

Closed rffontenelle closed 2 weeks ago

rffontenelle commented 3 weeks ago

Feature or Bugfix

Purpose

Remove the locale_dirs entry from documentation's conf.py to use the default value 'locales', which would avoid the need for setting -Dlocale_dirs

Detail

https://github.com/sphinx-doc/sphinx-doc-translations/pull/58 is just holding this to land.

Relates

jayaddison commented 3 weeks ago

@rffontenelle this follows-on from #13025 I guess?

rffontenelle commented 3 weeks ago

@jayaddison Sort of. After AA Turner message, I realized the issue was in the docs that states locale_dirs defaults to locale when the correct was locales. Well, Sphinx's own conf.py is set to 'locale', so I'm working on changing it.

AA-Turner commented 3 weeks ago

Is this setting currently causing trouble? The linked PR seems to move every file in the repo to locales.

A

P.S. Adam Turner (and most variants) was taken when I created my account on GitHub - my name isn't 'AA'!

rffontenelle commented 3 weeks ago

Is this setting currently causing trouble? The linked PR seems to move every file in the repo to locales.

No trouble at all. My intention is to remove -Dlocale_dirs from sphinx-build command line, and also to follow current Sphinx default (locales).

P.S. Adam Turner (and most variants) was taken when I created my account on GitHub - my name isn't 'AA'!

Sure, I apologize. It was a reference to your username.

AA-Turner commented 3 weeks ago

No need to apologise, don't worry.

Which PR should be merged first? I'll look at both tomorrow (UK time)

A

rffontenelle commented 3 weeks ago

Which PR should be merged first? I'll look at both tomorrow (UK time)

This one. That other one require solving a merge conflict caused by daily translation string update. I'll solve as soon as this is merged