Skip to content

Commit 353a11c

Browse files
offtherailzTobia Di Pisa
offtherailz
authored and
Tobia Di Pisa
committed
Readthedocs basic setup (#68)
* initial setup * add readthedocs.yml * add link to mapstore doc * fixed index * add contents.rst * add gitignore for doc build * moved contents file * moved everything in the docs dir * sync readthedocs with sphinx doc * set master_doc in conf.py * add link to official docuemntation * Setup docs * removed module index * add translation files * Generated fr lang structure. Updated gitignore * Updated fr translations * Fixed translation files * add localization doc * fixed typo * source/locale/fr/LC_MESSAGES/ * updated gitignore
1 parent adfe84f commit 353a11c

File tree

13 files changed

+465
-2
lines changed

13 files changed

+465
-2
lines changed

‎.gitignore

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,16 @@ node_modules/
22
libs/Cesium/
33
dist/
44
target/
5+
docs/source/_build
6+
docs/build
7+
docs/source/locale/**/*.mo
58
*.sublime-*
69
npm-debug.log
710
coverage/
8-
web/.classpath
9-
web/.project
11+
**/.classpath
12+
**/.project
13+
**/.settings
14+
.vscode
1015
backend/.classpath
1116
backend/.project
1217
package-lock.json

‎.readthedocs.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Build documentation in the docs/ directory with Sphinx
9+
sphinx:
10+
configuration: docs/source/conf.py
11+
12+
# Build documentation with MkDocs
13+
#mkdocs:
14+
# configuration: mkdocs.yml
15+
16+
# Optionally build your docs in additional formats such as PDF and ePub
17+
formats: all
18+
19+
# Optionally set the version of Python and requirements required to build your docs
20+
python:
21+
version: 3.7
22+
# install:
23+
# - requirements: docs/requirements.txt

‎docs/Makefile

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SOURCEDIR = source
8+
BUILDDIR = build
9+
10+
# Put it first so that "make" without argument is like "make help".
11+
help:
12+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13+
14+
.PHONY: help Makefile
15+
16+
# Catch-all target: route all unknown targets to Sphinx using the new
17+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18+
%: Makefile
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
33+
34+
:end
35+
popd

‎docs/source/cadastrapp/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
==========
2+
Cadastrapp
3+
==========
4+
5+
Welcome to Cadastrapp documentation.

‎docs/source/conf.py

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Configuration file for the Sphinx documentation builder.
4+
#
5+
# This file does only contain a selection of the most common options. For a
6+
# full list see the documentation:
7+
# http://www.sphinx-doc.org/en/master/config
8+
9+
# -- Path setup --------------------------------------------------------------
10+
11+
# If extensions (or modules to document with autodoc) are in another directory,
12+
# add these directories to sys.path here. If the directory is relative to the
13+
# documentation root, use os.path.abspath to make it absolute, like shown here.
14+
#
15+
# import os
16+
# import sys
17+
# sys.path.insert(0, os.path.abspath('.'))
18+
19+
20+
# -- Project information -----------------------------------------------------
21+
22+
project = u'Georchestra - MapStore'
23+
copyright = u'2019, GeoSolutions S.a.s.'
24+
author = u'GeoSolutions S.a.s.'
25+
26+
# The short X.Y version
27+
version = u''
28+
# The full version, including alpha/beta/rc tags
29+
release = u''
30+
31+
32+
# -- General configuration ---------------------------------------------------
33+
34+
# If your documentation needs a minimal Sphinx version, state it here.
35+
#
36+
# needs_sphinx = '1.0'
37+
38+
# Add any Sphinx extension module names here, as strings. They can be
39+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40+
# ones.
41+
extensions = [
42+
'sphinx.ext.githubpages',
43+
'sphinx_rtd_theme',
44+
'recommonmark'
45+
]
46+
47+
# Add any paths that contain templates here, relative to this directory.
48+
templates_path = ['_templates']
49+
50+
# The suffix(es) of source filenames.
51+
# You can specify multiple suffix as a list of string:
52+
#
53+
# source_suffix = ['.rst', '.md']
54+
source_suffix = '.rst'
55+
56+
# The master toctree document.
57+
master_doc = 'index'
58+
59+
# The language for content autogenerated by Sphinx. Refer to documentation
60+
# for a list of supported languages.
61+
#
62+
# This is also used if you do content translation via gettext catalogs.
63+
# Usually you set "language" from the command line for these cases.
64+
language = None
65+
locale_dirs = ['locale/'] # path is example but recommended.
66+
gettext_compact = False # optional.
67+
68+
# List of patterns, relative to source directory, that match files and
69+
# directories to ignore when looking for source files.
70+
# This pattern also affects html_static_path and html_extra_path.
71+
exclude_patterns = []
72+
73+
# The name of the Pygments (syntax highlighting) style to use.
74+
pygments_style = None
75+
76+
77+
# -- Options for HTML output -------------------------------------------------
78+
79+
# The theme to use for HTML and HTML Help pages. See the documentation for
80+
# a list of builtin themes.
81+
#
82+
html_theme = 'sphinx_rtd_theme'
83+
84+
# Theme options are theme-specific and customize the look and feel of a theme
85+
# further. For a list of options available for each theme, see the
86+
# documentation.
87+
#
88+
# html_theme_options = {}
89+
90+
# Add any paths that contain custom static files (such as style sheets) here,
91+
# relative to this directory. They are copied after the builtin static files,
92+
# so a file named "default.css" will overwrite the builtin "default.css".
93+
html_static_path = ['_static']
94+
95+
# Custom sidebar templates, must be a dictionary that maps document names
96+
# to template names.
97+
#
98+
# The default sidebars (for documents that don't match any pattern) are
99+
# defined by theme itself. Builtin themes are using these templates by
100+
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
101+
# 'searchbox.html']``.
102+
#
103+
# html_sidebars = {}
104+
105+
106+
# -- Options for HTMLHelp output ---------------------------------------------
107+
108+
# Output file base name for HTML help builder.
109+
htmlhelp_basename = 'Georchestra-MapStoredoc'
110+
111+
112+
# -- Options for LaTeX output ------------------------------------------------
113+
114+
latex_elements = {
115+
# The paper size ('letterpaper' or 'a4paper').
116+
#
117+
# 'papersize': 'letterpaper',
118+
119+
# The font size ('10pt', '11pt' or '12pt').
120+
#
121+
# 'pointsize': '10pt',
122+
123+
# Additional stuff for the LaTeX preamble.
124+
#
125+
# 'preamble': '',
126+
127+
# Latex figure (float) alignment
128+
#
129+
# 'figure_align': 'htbp',
130+
}
131+
132+
# Grouping the document tree into LaTeX files. List of tuples
133+
# (source start file, target name, title,
134+
# author, documentclass [howto, manual, or own class]).
135+
latex_documents = [
136+
(master_doc, 'Georchestra-MapStore.tex', u'Georchestra - MapStore Documentation',
137+
u'GeoSolutions S.a.s.', 'manual'),
138+
]
139+
140+
141+
# -- Options for manual page output ------------------------------------------
142+
143+
# One entry per manual page. List of tuples
144+
# (source start file, name, description, authors, manual section).
145+
man_pages = [
146+
(master_doc, 'georchestra-mapstore', u'Georchestra - MapStore Documentation',
147+
[author], 1)
148+
]
149+
150+
151+
# -- Options for Texinfo output ----------------------------------------------
152+
153+
# Grouping the document tree into Texinfo files. List of tuples
154+
# (source start file, target name, title, author,
155+
# dir menu entry, description, category)
156+
texinfo_documents = [
157+
(master_doc, 'Georchestra-MapStore', u'Georchestra - MapStore Documentation',
158+
author, 'Georchestra-MapStore', 'One line description of project.',
159+
'Miscellaneous'),
160+
]
161+
162+
163+
# -- Options for Epub output -------------------------------------------------
164+
165+
# Bibliographic Dublin Core info.
166+
epub_title = project
167+
168+
# The unique identifier of the text. This can be a ISBN number
169+
# or the project homepage.
170+
#
171+
# epub_identifier = ''
172+
173+
# A unique identification for the text.
174+
#
175+
# epub_uid = ''
176+
177+
# A list of files that should not be packed into the epub file.
178+
epub_exclude_files = ['search.html']
179+
180+
181+
# -- Extension configuration -------------------------------------------------

‎docs/source/index.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. Georchestra - MapStore documentation master file, created by
2+
sphinx-quickstart on Thu Oct 10 12:25:43 2019.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to Georchestra documentation!
7+
=====================================
8+
9+
.. toctree::
10+
:maxdepth: 4
11+
12+
cadastrapp/index
13+
mapstore/index
14+
localize
15+
16+
17+
18+
Indices and tables
19+
==================
20+
21+
* :ref:`genindex`
22+
* :ref:`search`

‎docs/source/locale/fr/LC_MESSAGES/cadastrapp/index.po

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2019, GeoSolutions S.a.s.
3+
# This file is distributed under the same license as the Georchestra -
4+
# MapStore package.
5+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
6+
#
7+
#, fuzzy
8+
msgid ""
9+
msgstr ""
10+
"Project-Id-Version: Georchestra - MapStore \n"
11+
"Report-Msgid-Bugs-To: \n"
12+
"POT-Creation-Date: 2019-10-11 10:32+0200\n"
13+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
14+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
15+
"Language-Team: LANGUAGE <LL@li.org>\n"
16+
"MIME-Version: 1.0\n"
17+
"Content-Type: text/plain; charset=utf-8\n"
18+
"Content-Transfer-Encoding: 8bit\n"
19+
"Generated-By: Babel 2.7.0\n"
20+
21+
#: ../../source/cadastrapp/index.rst:3
22+
msgid "Cadastrapp"
23+
msgstr "Cadastrapp"
24+
25+
#: ../../source/cadastrapp/index.rst:5
26+
msgid "Welcome to Cadastrapp documentation."
27+
msgstr "Bienvenue dans la documentation Cadastrapp."
28+

‎docs/source/locale/fr/LC_MESSAGES/index.po

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2019, GeoSolutions S.a.s.
3+
# This file is distributed under the same license as the Georchestra -
4+
# MapStore package.
5+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2019.
6+
#
7+
#, fuzzy
8+
msgid ""
9+
msgstr ""
10+
"Project-Id-Version: Georchestra - MapStore \n"
11+
"Report-Msgid-Bugs-To: \n"
12+
"POT-Creation-Date: 2019-10-11 10:31+0200\n"
13+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
14+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
15+
"Language-Team: LANGUAGE <LL@li.org>\n"
16+
"MIME-Version: 1.0\n"
17+
"Content-Type: text/plain; charset=utf-8\n"
18+
"Content-Transfer-Encoding: 8bit\n"
19+
"Generated-By: Babel 2.7.0\n"
20+
21+
#: ../../source/index.rst:7
22+
msgid "Welcome to Georchestra documentation!"
23+
msgstr "Bienvenue dans Georchestra - Documentation"
24+
25+
#: ../../source/index.rst:18
26+
msgid "Indices and tables"
27+
msgstr "Indices et tableau"
28+
29+
#: ../../source/index.rst:20
30+
msgid ":ref:`genindex`"
31+
msgstr ":ref:`genindex`"
32+
33+
#: ../../source/index.rst:21
34+
msgid ":ref:`search`"
35+
msgstr ":ref:`search`"

0 commit comments

Comments
 (0)