-
Notifications
You must be signed in to change notification settings - Fork 25
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)
Then adding the project to the translations in the Translations file
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
The root project and the localized sub-projects should be configured to use same domain like in this case.