Merge pull request #80 from impresso/version_change_and_doc_update

Version 1.0.0 and doc update
impresso · Dec 12, 2023 · ac2f64f · ac2f64f
2 parents 736bf18 + c8ee8fe
commit ac2f64f
Show file tree

Hide file tree

Showing 35 changed files with 880 additions and 415 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,60 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+
+build:
+
+  os: ubuntu-22.04
+
+  tools:
+
+    python: "3.10"
+
+    # You can also specify other tool versions:
+
+    # nodejs: "20"
+
+    # rust: "1.70"
+
+    # golang: "1.20"
+
+
+# Build documentation in the "docs/" directory with Sphinx
+
+sphinx:
+
+  configuration: docs/conf.py
+
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+
+  builder: "html"
+
+  # Fail on all warnings to avoid broken references
+
+  fail_on_warning: true
+
+
+# Optionally build your docs in additional formats such as PDF and ePub
+
+# formats:
+
+#   - pdf
+
+#   - epub
+
+
+# Optional but recommended, declare the Python requirements required
+
+# to build your documentation
+
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+
+python:
+
+  install:
+
+    - requirements: ./requirements.txt
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
@@ -13,6 +13,7 @@
 #
 # Please keep the list sorted (by last name).
 
+Pauline Conti (piconti)
 Maud Ehrmann (e-maud)
 Alex Flückliger (aflueckiger)
 Edoardo Tarek Höelzl (ehoelzl) 

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/images.doctree b/docs/_build/doctrees/images.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/io.doctree b/docs/_build/doctrees/io.doctree
diff --git a/docs/_build/doctrees/rebuild.doctree b/docs/_build/doctrees/rebuild.doctree
diff --git a/docs/_build/doctrees/utils.doctree b/docs/_build/doctrees/utils.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 52a307b7b889569b6d220f068464a8b3
+config: db095930451fa623d6abd869823c71e5
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -18,10 +18,3 @@ Python module with bits of code (objects, functions) highly reusable within impr
    utils
    images
 
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/_build/html/_sources/rebuild.rst.txt b/docs/_build/html/_sources/rebuild.rst.txt
@@ -1,28 +1,12 @@
 Text Rebuild
 ==============================
 
-Command Line interface
-----------------------
-
-.. automodule:: impresso_commons.text.rebuilder
-
-
-Config file example
--------------------
-
-(from file: `cluster.json`)::
-
-
-    [
-        {
-            "GDL": [1900, 1999]
-        }
-    ]
-
-
 Rebuild functions
 -----------------
 
+A set of functions to transform JSON files in **impresso's canonical format**
+into a number of JSON-based formats for different purposes.
+
 .. automodule:: impresso_commons.text.rebuilder
    :members:
    :undoc-members:
@@ -36,8 +20,9 @@ Helpers
    :undoc-members:
    :show-inheritance:
 
-Running Rebuild on Runai
-------------------------
+Config file example
+-------------------
+
+(from file: `cluster.json`)::
 
-.. include:: ../scripts/rebuild_on_runai.md
-    :parser: myst_parser.sphinx_
+    [{"GDL": [1900, 1999]}]