sphinx-doc.org on the Read The Docs with multi-versions/languages

[Takayuki Shimizukawa]

Hi,

I've tried to provide Sphinx official documentation with multiple versions and multiple languages on Read The Docs site and finally I find a reasonable way to achieve it.

http://shimizukawa-sphinx.readthedocs.org/

This is a site in experimental.

https://github.com/shimizukawa/shimizukawa-sphinx-docs

This is a Sphinx documentation to build each languages that have conf.py files and po files for each languages. It also have branches for each versions.

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 sphinx-build command. Unfortunately Read the Docs can't. If there are any better way, please let me know.

Be that as it may, it looks fine.

I think sphinx-doc.org move on Read the docs is good choice. 

How do you think?

Best regards,

--

Takayuki SHIMIZUKAWA

http://about.me/shimizukawa

[Eric Holscher]

We're happy to help make this happen any way we can. We'd love to host the official docs :)

We do support localization, by passing the "language" for each version of the docs. It's currently a bit hacky -- http://docs.readthedocs.org/en/latest/localization.html#project-with-multiple-translations

It basically requires setting up a project for each language, and then adding them as "translations" to the master version. Then it will be served properly under the language code on the top-level project.

Again, I'm happy to help make this a reasonable process and if there are changes we need to add to RTD, that can definitely happen.

Cheers,

Eric

[gilberto dos santos alves]

Great! pt_BR is working too. [1]. we continue translating docs. thanks more this big step. happy new year!, now "feliz ano novo!" locale pt_BR.

[1] http://shimizukawa-sphinx.readthedocs.org/pt_BR/1.3.3/index.html

--
You received this message because you are subscribed to the Google Groups "sphinx-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-dev+...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--

gilberto dos santos alves
+55(11)9-8646-5049
sao paulo - sp - brasil

[Georg Brandl]

On 01/06/2016 03:49 PM, Takayuki Shimizukawa wrote:
> Hi,
>
> I've tried to provide Sphinx official documentation with multiple versions and
> multiple languages on Read The Docs site and finally I find a reasonable way to
> achieve it.
>
> http://shimizukawa-sphinx.readthedocs.org/
> This is a site in experimental.
>
> https://github.com/shimizukawa/shimizukawa-sphinx-docs
> This is a Sphinx documentation to build each languages that have conf.py files
> and po files for each languages. It also have branches for each versions.
>
> 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 sphinx-build
> command. Unfortunately Read the Docs can't. If there are any better way, please
> let me know.
>
> Be that as it may, it looks fine.

> I think sphinx-doc.org <http://sphinx-doc.org> move on Read the docs is good

> choice.
> How do you think?

I'm happy with it. Let me know when I should point the domain somewhere else.

cheers,
Georg

[Takayuki Shimizukawa]

Hi there,

Thanks for you comments. Now I've prepared all settings on RTD.

https://readthedocs.org/projects/sphinx/

Georg, please update DNS record as:

    sphinx-doc.org.   7200    IN  CNAME   sphinx.readthedocs.org.

refs: http://read-the-docs.readthedocs.org/en/latest/alternate_domains.html#cname-support

Eric, IMHO, if RTD accepts command line options for sphinx-build, it makes easier to setup RTD project for each languages.

A similar issue is already filed and closed: https://github.com/rtfd/readthedocs.org/issues/1573

Anyhow, thanks for your great works on RTD!

Regards,

--

Takayuki SHIMIZUKAWA

http://about.me/shimizukawa

[Georg Brandl]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 01/09/2016 03:16 AM, Takayuki Shimizukawa wrote:
> Hi there,
>
> Thanks for you comments. Now I've prepared all settings on RTD.
> https://readthedocs.org/projects/sphinx/

Great!

> Georg, please update DNS record as:
>

> sphinx-doc.org <http://sphinx-doc.org>. 7200 IN CNAME
> sphinx.readthedocs.org <http://sphinx.readthedocs.org>.
>
> refs:
> http://read-the-docs.readthedocs.org/en/latest/alternate_domains.html#cname-su
pport

I've
>
added a CNAME for any subdomain for now. I can't add a CNAME for the root
domain, so http://sphinx-doc.org/ will redirect to http://www.sphinx-doc.org/
first. Of course, the change will need a bit of time to propagate.

cheers,
Georg
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iEYEARECAAYFAlaQxPQACgkQN9GcIYhpnLBIEQCfSsrXZk8RYvzUBA9MD+7mrPsG
a8EAoK15HM/MxTCsni6axRIZAUkJMNgc
=dnlo
-----END PGP SIGNATURE-----

[Dmitry Shachnev]

Hi all,

On Sat, 9 Jan 2016 09:29:40 +0100, Georg Brandl wrote:
> I've added a CNAME for any subdomain for now. I can't add a CNAME for the root
> domain, so http://sphinx-doc.org/ will redirect to http://www.sphinx-doc.org/
> first. Of course, the change will need a bit of time to propagate.

The switch to readthedocs has broken some links.

For example, http://sphinx-doc.org/config.html (linked from alabaster README)
is now 404.

--
Dmitry Shachnev

[Georg Brandl]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Indeed, sorry. I have now added a RTD redirect to address that, please check.

Georg
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iEYEARECAAYFAlaQ5IIACgkQN9GcIYhpnLAc8wCglmN9NQNCfyjOsGBVlm6ru/DO
U04An3E+bmhQRanl2Dk5QFdnHQwF1EGU
=zhJJ
-----END PGP SIGNATURE-----

[Dmitry Shachnev]

Hi Georg,

On Sat, Jan 09, 2016 at 11:44:18AM +0100, Georg Brandl wrote:
> Indeed, sorry. I have now added a RTD redirect to address that, please check.

Works fine now, thanks!

--
Dmitry Shachnev

[Takayuki Shimizukawa]

Hi,

http://www.sphinx-doc.org/en/1.3.4/ is deployed and it looks fine.

And other languages are deployed as /<lang>/1.3/  path and looks also fine.

BTW, updating procedure for other languages is still troublesome.. 

I'm going to find a way for automation.

Anyway, thanks for your cooperation!

--

Takayuki SHIMIZUKAWA

http://about.me/shimizukawa

[Eric Holscher]

Our API is currently in a pretty sad state, but making this easier is definitely something we're going to work on soon! I can help and try to build a script that supports it, and I can build against the RTD backend to support it sanely, while doing it :)

--
You received this message because you are subscribed to a topic in the Google Groups "sphinx-dev" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/sphinx-dev/Mzu4WkVQtR8/unsubscribe.
To unsubscribe from this group and all its topics, send an email to sphinx-dev+...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--

Eric Holscher
Maker of the internet residing in Portland, Oregon
http://ericholscher.com