Changeset 5

Timestamp:

09/30/15 10:26:55 (9 years ago)

Author:

pinsard

Message:

add some graphics

Location:

trunk/docs/manual

Files:

• for_figs (added)
• for_figs/libigcmprod.dot (added)
• source/conf.py (modified) (3 diffs)
• source/developers/guides/typo.rst (modified) (7 diffs)
• source/developers/guides/typo_blockdiag.dot (added)
• source/developers/guides/typo_seqdiag.dot (added)
• source/index.rst (modified) (1 diff)

trunk/docs/manual/source/conf.py

@@ -39 +39 @@
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
+    'sphinx.ext.graphviz',
+    'sphinxcontrib.blockdiag',
 ]
 
+# Enable debug mode of blockdiag.
+blockdiag_debug = True
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -124 +128 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+html_theme = 'sphinxdoc'
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -371 +375 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'https://docs.python.org/2': None}

trunk/docs/manual/source/developers/guides/typo.rst

@@ -8 +8 @@
 
 They use dictionaries providing natural langages list of words.
+
+Here is the flow 
+
+.. blockdiag:: typo_blockdiag.dot
 
 Missing words in dictionaries
@@ -83 +87 @@
    done
    cat ${PROJECT_LOG}/pyigcmg_doc_var.txt >> ${nontypo}
-   sort --ignore-case -u ${nontypo} > ${nontypo_uniq}
+   sort -u ${nontypo} > ${nontypo_uniq}
 
 Check typo in Python files
@@ -99 +103 @@
    --reports=n \
    ${listf} | grep "Wrong spelling" | awk -F: '{print $3}' | \
-   sort --ignore-case -u > ${PROJECT_LOG}/typo
+   sort -u > ${PROJECT_LOG}/typo
 
 .. todo::
@@ -122 +126 @@
 .. tip::
 
-   To see the path of existing default dictonaries of :command:`hunspell` :
+   To see the path of existing default dictionaries of :command:`hunspell` :
 
    .. code-block:: bash
@@ -167 +171 @@
       hunspell -d en_US,nontypo_uniq --check-url -i utf-8 -l < ${onefile} >> ${hunspell_out}
    done
-   sort --ignore-case -u ${hunspell_out} > ${hunspell_uniq_out}
+   sort -u ${hunspell_out} > ${hunspell_uniq_out}
 
 .. todo::
@@ -190 +194 @@
 
 Until :ref:`tracwiki_migration` is not achieved, we have to check typo in 
-HTML files produced by trac on the <http://forge.ipsl.jussieu.fr/igcmg_doc/wiki/>_
-
-To get all wiki Doc* pages URI of http://forge.ipsl.jussieu.fr/igcmg_doc/ :
-
-.. code-block:: bash
-
-   list_uri=$(xsltproc \-\-novalid ${PROJECT}/docs/manual/for_tracwiki/titleindex.xsl http://forge.ipsl.jussieu.fr/igcmg_doc/wiki/TitleIndex | \
-   grep "/igcmg_doc/wiki/Doc" | sort -u | \
+HTML files produced by trac on the `<http://forge.ipsl.jussieu.fr/igcmg_doc/wiki/>`_
+
+By convention, it has been decided to start all |igcmg_doc| pages names by ``Doc``.
+
+To get all wiki Doc* pages URI of `<http://forge.ipsl.jussieu.fr/igcmg_doc/>`_ [#tracoops]_:
+
+.. code-block:: bash
+
+   excluded_uri=DocYgraphvizLibigcmprod
+   list_uri=$(xsltproc \-\-novalid \
+   ${PROJECT}/docs/manual/for_tracwiki/titleindex.xsl http://forge.ipsl.jussieu.fr/igcmg_doc/wiki/TitleIndex | \
+   grep "/igcmg_doc/wiki/Doc" | grep -v ${excluded_uri} |sort -u | \
    sed -e "s@^@http://forge.ipsl.jussieu.fr/@")
 
-To download those URI localy:
+.. [#tracoops] we exclude DocYgraphvizLibigcmprod because Trac detected an internal error ... some graphviz trac plugins issue
+
+To download those URI locally:
 
 .. code-block:: bash
@@ -224 +234 @@
       hunspell -d en_US,nontypo_uniq --check-url -i utf-8 -l < ${onefile} >> ${hunspell_out}
    done
-   sort --ignore-case -u ${hunspell_out} > ${hunspell_uniq_out}
+   sort -u ${hunspell_out} > ${hunspell_uniq_out}
 
 To find one of the wrong spelling in downloaded HTML pages:

trunk/docs/manual/source/index.rst

@@ -12 +12 @@
    :maxdepth: 2
 
+.. graphviz:: ../for_figs/libigcmprod.dot
+
 Indices and tables
 ==================