Skip to content
This repository has been archived by the owner on Nov 24, 2021. It is now read-only.

Commit

Permalink
Silent Documentation Update 4.5.12
Browse files Browse the repository at this point in the history
  • Loading branch information
dirkroorda committed Mar 2, 2016
1 parent 90aa54e commit c937d9a
Show file tree
Hide file tree
Showing 20 changed files with 2,603 additions and 585 deletions.
3 changes: 3 additions & 0 deletions MANIFEST
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ emdros2laf/laf.py
emdros2laf/mylib.py
emdros2laf/run.py
emdros2laf/settings.py
emdros2laf/settings_conflict-20160221-210653.py
emdros2laf/transform.py
emdros2laf/validate.py
emdros2laf/templates/annotation_decl.xml
Expand Down Expand Up @@ -59,6 +60,8 @@ laf/fabric.py
laf/lib.py
laf/model.py
laf/names.py
laf/names_conflict-20160218-110922.py
laf/parse.py
laf/settings.py
laf/settings_conflict-20160221-210653.py
laf/timestamp.py
Binary file added dist/laf-fabric-4.5.12.tar.gz
Binary file not shown.
Binary file removed dist/laf-fabric-4.5.17.tar.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
project = u'LAF Fabric'
copyright = u'2013, Dirk Roorda'
version = '4.5'
release = '4.5.17'
release = '4.5.12'
exclude_patterns = ['_build']
add_function_parentheses = True
add_module_names = False
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py.bck
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ master_doc = 'index'
project = u'LAF Fabric'
copyright = u'2013, Dirk Roorda'
version = '4.5'
release = '4.5.17'
release = '4.5.12'
exclude_patterns = ['_build']
add_function_parentheses = True
add_module_names = False
Expand Down
89 changes: 89 additions & 0 deletions docs/conf.py_conflict-20160218-170310.bck
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# -*- coding: utf-8 -*-

import sys
import os

sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath('../tasks'))

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
]

intersphinx_mapping = {'python': ('http://docs.python.org/3.3', None)}

templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
project = u'LAF Fabric'
copyright = u'2013, Dirk Roorda'
version = '4.5'
release = '4.5.17'
exclude_patterns = ['_build']
add_function_parentheses = True
add_module_names = False
pygments_style = 'sphinx'
autoclass_content = 'both'

# -- Options for HTML output ----------------------------------------------

on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if on_rtd:
html_theme = 'default'
else:
html_theme = 'sphinx_rtd_theme'
html_theme_path = ["_themes", ]

html_static_path = ['_static']
html_domain_indices = True
html_use_index = True
html_split_index = False
html_show_sourcelink = True
html_show_sphinx = True
html_show_copyright = True
htmlhelp_basename = 'LAF Fabric'

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
'papersize': 'a4paper',
'pointsize': '10pt',
}

latex_documents = [
('index', 'LAF_Fabric.tex', u'LAF Fabric Documentation',
u'Dirk Roorda', 'manual'),
]

# -- Options for manual page output ---------------------------------------

man_pages = [
('index', 'LAF_Fabric', u'LAF Fabric Documentation',
[u'Dirk Roorda'], 1)
]

# -- Options for Texinfo output -------------------------------------------

texinfo_documents = [
('index', 'LAF_Fabric', u'LAF Fabric Documentation',
u'Dirk Roorda', 'LAF Fabric', 'One line description of project_name.',
'Miscellaneous'),
]

# -- Options for Epub output ----------------------------------------------

epub_title = u'LAF Fabric'
epub_author = u'Dirk Roorda'
epub_publisher = u'Dirk Roorda'
epub_copyright = u'2013, Dirk Roorda'
epub_basename = u'LAF_Fabric'
epub_theme = 'epub'
epub_show_urls = 'footnote'
epub_use_index = True
89 changes: 89 additions & 0 deletions docs/conf_conflict-20160221-210726.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# -*- coding: utf-8 -*-

import sys
import os

sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath('../tasks'))

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
]

intersphinx_mapping = {'python': ('http://docs.python.org/3.3', None)}

templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
project = u'LAF Fabric'
copyright = u'2013, Dirk Roorda'
version = '4.5'
release = '4.5.17'
exclude_patterns = ['_build']
add_function_parentheses = True
add_module_names = False
pygments_style = 'sphinx'
autoclass_content = 'both'

# -- Options for HTML output ----------------------------------------------

on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if on_rtd:
html_theme = 'default'
else:
html_theme = 'sphinx_rtd_theme'
html_theme_path = ["_themes", ]

html_static_path = ['_static']
html_domain_indices = True
html_use_index = True
html_split_index = False
html_show_sourcelink = True
html_show_sphinx = True
html_show_copyright = True
htmlhelp_basename = 'LAF Fabric'

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
'papersize': 'a4paper',
'pointsize': '10pt',
}

latex_documents = [
('index', 'LAF_Fabric.tex', u'LAF Fabric Documentation',
u'Dirk Roorda', 'manual'),
]

# -- Options for manual page output ---------------------------------------

man_pages = [
('index', 'LAF_Fabric', u'LAF Fabric Documentation',
[u'Dirk Roorda'], 1)
]

# -- Options for Texinfo output -------------------------------------------

texinfo_documents = [
('index', 'LAF_Fabric', u'LAF Fabric Documentation',
u'Dirk Roorda', 'LAF Fabric', 'One line description of project_name.',
'Miscellaneous'),
]

# -- Options for Epub output ----------------------------------------------

epub_title = u'LAF Fabric'
epub_author = u'Dirk Roorda'
epub_publisher = u'Dirk Roorda'
epub_copyright = u'2013, Dirk Roorda'
epub_basename = u'LAF_Fabric'
epub_theme = 'epub'
epub_show_urls = 'footnote'
epub_use_index = True
72 changes: 8 additions & 64 deletions docs/texts/ETCBC-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,59 +98,39 @@ and say in your load instructions::

'prepare': prepare
Then you can use the following functions

.. code-block:: python
Then you can use the following functions::

T.node_of(book, chapter, verse)

Yields the verse node of the passage specified by `book`, `chapter` and `verse`.
Yields `None` if there is no such verse.

Book must be given as a *node*, the book name for the verse_label will be in language `lang`.
See the methods `book_name()` and `book_node()` below to map a book name to a book node and vice versa.

.. code-block:: python
Yields `None` if there is no such verse.::

T.formats()

This yields a dictionary of all formats that the ``T`` API is capable to deliver.
The keys are acronymns for the formats, the values are tuples
``(desc, method)``
where ``desc`` is a short description of the format, and ``method`` is a Python function that delivers that representation given a single word node.

.. code-block:: python
where ``desc`` is a short description of the format, and ``method`` is a Python function that delivers that representation given a single word node.:

T.words(word_nodes, fmt='ha')

Give the plain text belonging to a series of words in format ``fmt``.
Default format is ``ha``, i.e. fully pointed Hebrew Unicode, where ketivs have been replaced by
fully pointed qeres.
The ``word_nodes`` can be any iterable of nodes carrying ``otype = 'word'``.
They do not have to correspond to consecutive words in the bible.

.. code-block:: python
They do not have to correspond to consecutive words in the bible.:

T.verse(book, chapter, verse, fmt='ha', html=True, verse_label=True, format_label=True, lang='en')
T.verse(book, chapter, verse, fmt='ha', html=True, verse_label=True, format_label=True)

Give the plain text of the indicated verse in format ``fmt``.
You can choose wether to include a verse label (like ``Genesis 3:7``) and a format label
(like ``hebrew accent``).

If ``html`` is ``True`` then the result is formatted as a html table, with the right style characteristics.
You can still tweak the styles a bit, see the function ``T.style()`` later on.
You can still tweak the styles a bit, see the function ``T.style()`` later on.:

Like in `node_of()`, `book` must be given as a node.
See the methods `book_name()` and `book_node()` below to map a book name to a book node and vice versa.
T.whole(fmt='ha', verse_labels=False)

.. code-block:: python
T.whole(fmt='ha', verse_labels=False, lang='en')
Give the plain text of the whole Bible in format ``fmt``.
The language for the book names in the verse labels is given by `lang`.

.. code-block:: python
Give the plain text of the whole Bible in format ``fmt``.:

T.style(params=None, show_params=False)

Expand All @@ -164,42 +144,6 @@ You can also set the widths of the label columns.

You only have to pass the parameters that you want to give a non-default value.

.. code-block:: python
T.book_name(book_node, lang='en')
Returns the book name of the book corresponding to `book_node` in language `lang`.

.. code-block:: python
T.book_node(book_name, lang='en')
Returns the book node of the book with name `book_name` in language `lang`.

If `lang` is `la` (latin), the book names are exactly as used in the ETCBC database.

Supported languages:

* en = English (default)
* nl = Dutch
* de = German
* fr = French
* el = Greek
* he = Hebrew (modern)
* la = Latin (used in the ETCBC database).

For the list of all languages, call

.. code-block:: python
T.langs
.. code-block:: python
T.book_nodes
For convenience, the tuple of nodes corresponding to the books in the ETCBC order.

.. _node_order:

Node order
Expand Down

0 comments on commit c937d9a

Please sign in to comment.