Skip to content
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.

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

Readthedocs basic setup #68

Merged
merged 21 commits into from
Oct 18, 2019
Merged

Conversation

offtherailz
Copy link
Collaborator

@offtherailz offtherailz commented Oct 11, 2019

This PR contains a sample of sphinx documentation compatible with multi-language setup on readthedocs.

The result of this PR is deployed here:
http://docs.georchestra.geo-solutions.it

Inside the sample there is already a small page dedicated to "Localize this documentation" that shows how to update translation files"

Theme

The example in the PR uses readthedocs theme, that can be customized a little following this documentation. This allows basically to do simple customization.
We tested that also the albaster theme (the sphinx default) works on read the docs.

If interested to big customization, an investigation about using different themes (like these) or doing own we need to investigate more about feasability.

ReadtheDocs setup

Here the needed configurations to setup multi-language and custom domain.

Multi language support

ReadTheDocs allow (as documented here) to publish multi-language documentation using sphinx
This is allowed by creating 1 main project and other sub-projects (configured with a different languages in readthedocs project's administrator configuration)
image

Then adding the project to the translations in the Translations file
image

Custom domain

Readthedocs supports customdomains as documented here:
Contextually to this pull request we configured the exampled to this URL:
http://docs.georchestra.geo-solutions.it
image

The root project and the localized sub-projects should be configured to use same domain like in this case.

@tdipisa tdipisa self-requested a review October 11, 2019 14:14
@tdipisa tdipisa added this to the Phase I milestone Oct 11, 2019
@tdipisa tdipisa added the documentation Improvements or additions to documentation label Oct 11, 2019
@tdipisa tdipisa merged commit 353a11c into georchestra:master Oct 18, 2019
@tdipisa tdipisa self-assigned this Nov 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants