diff --git a/doc/source/_static/general_epilog.rst b/doc/source/_static/general_epilog.rst new file mode 100644 index 0000000..b0d1776 --- /dev/null +++ b/doc/source/_static/general_epilog.rst @@ -0,0 +1,7 @@ + +.. |array-return| replace:: *Array return value* + +.. |float-return| replace:: *Floating point return value* + +.. |long-return| replace:: *Integer return value* + diff --git a/doc/source/_static/udfref_epilog.rst b/doc/source/_static/udfref_epilog.rst new file mode 100644 index 0000000..604d963 --- /dev/null +++ b/doc/source/_static/udfref_epilog.rst @@ -0,0 +1,5 @@ + +.. |udf-TRANSPOSE| replace:: ``TRANSPOSE()`` + +.. _udf-TRANSPOSE: https://support.office.com/en-us/article/TRANSPOSE-function-ed039415-ed8a-4a81-93e9-4b6dfac76027?CorrelationId=3fec08b8-22d3-4a7d-9a35-b57b1edc7ea9&ui=en-US&rs=en-US&ad=US + diff --git a/doc/source/_static/vbaref_epilog.rst b/doc/source/_static/vbaref_epilog.rst new file mode 100644 index 0000000..b43c4b8 --- /dev/null +++ b/doc/source/_static/vbaref_epilog.rst @@ -0,0 +1,12 @@ + +.. _vbaRefRoot: https://msdn.microsoft.com/en-us/library/office/jj692818.aspx + +.. |vba-IsArray| replace:: ``IsArray()`` + +.. _vba-IsArray: https://msdn.microsoft.com/en-us//library/office/gg264552.aspx + +.. |xl-TRANSPOSE| replace:: ``TRANSPOSE()`` + +.. _xl-TRANSPOSE: https://msdn.microsoft.com/en-us/library/office/ff196261.aspx + + diff --git a/doc/source/conf.py b/doc/source/conf.py index b595973..b26a56c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -31,6 +31,7 @@ # ones. extensions = [ 'sphinx.ext.mathjax', + 'sphinx.ext.intersphinx', # 'sphinx.ext.autodoc', # 'sphinx.ext.napoleon' ] @@ -79,7 +80,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = [] +exclude_patterns = ['_static/*'] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -111,6 +112,12 @@ # Suppressing selected warnings suppress_warnings = ['image.nonlocal_uri'] +# Epilog +rst_epilog = "" +for fname in [n for n in os.listdir('_static') if n.endswith('epilog.rst')]: + with open(os.path.join("_static", fname) , 'r') as f: + rst_epilog = rst_epilog + f.read() +del fname, f # -- Options for HTML output ---------------------------------------------- @@ -362,3 +369,9 @@ # If false, no index is generated. #epub_use_index = True + + +# Intersphinx mapping +#intersphinx_mapping = { +# 'xlwsf': ('https://support.office.com/en-us/', 'C:\\objects.inv') +# } \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index c15a6eb..f54954c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -22,6 +22,7 @@ Indices and tables ================== * :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + +.. * :ref:`modindex` +.. * :ref:`search` diff --git a/doc/source/udf/index.rst b/doc/source/udf/index.rst index 93b41ff..415caae 100644 --- a/doc/source/udf/index.rst +++ b/doc/source/udf/index.rst @@ -3,6 +3,9 @@ Worksheet Functions Reference ============================= +*Note here about, and link to instructions for, entering array formulas, +for those functions needing them.* + Contents: .. toctree:: diff --git a/doc/source/udf/matrix.rst b/doc/source/udf/matrix.rst index 4593a03..0007dd0 100644 --- a/doc/source/udf/matrix.rst +++ b/doc/source/udf/matrix.rst @@ -5,10 +5,17 @@ Matrix Functions *All should work when taking range references. Quirky if typing arrays explicitly into the formula.* -.. function:: mTranspose(ByVal mtx As Variant) As Variant +.. _udf-mtx-mTranspose: + +.. function:: mTranspose(mtx) + :noindex: + + |array-return| + + VBA reference: :func:`mTranspose` + + Returns the transpose of `mtx`. Identical behavior to the build-in |udf-TRANSPOSE|_. - Wrapper around a call to the built-in ``MTRANSPOSE`` function that raises a customized RTE 13 - (type mismatch) if the argument is not a 2-D Array. .. toctree:: diff --git a/doc/source/vba/assert.rst b/doc/source/vba/assert.rst index ca6e34a..a125d36 100644 --- a/doc/source/vba/assert.rst +++ b/doc/source/vba/assert.rst @@ -8,7 +8,7 @@ desirable, if time-consuming. :-/* .. function:: assertIsArray(vnt As Variant) - Wrapper around an ``IsArray()`` call that raises a customized RTE 13 + Wrapper around an |vba-IsArray|_ call that raises a customized RTE 13 (type mismatch) if the argument is not an Array. diff --git a/doc/source/vba/index.rst b/doc/source/vba/index.rst index 27cb871..aa00394 100644 --- a/doc/source/vba/index.rst +++ b/doc/source/vba/index.rst @@ -11,5 +11,6 @@ Contents: :maxdepth: 1 assert + matrix diff --git a/doc/source/vba/matrix.rst b/doc/source/vba/matrix.rst new file mode 100644 index 0000000..d664bce --- /dev/null +++ b/doc/source/vba/matrix.rst @@ -0,0 +1,21 @@ +.. Matrix-input functions + +Matrix Functions +================ + +*All should work when taking range references; all require 2-D Array inputs.* + +.. function:: mTranspose(ByVal mtx As Variant) + + *Returns:* 2-D Array + + *Worksheet function:* :ref:`mTranspose ` + + Wrapper around a call to the built-in |xl-TRANSPOSE|_ function that raises a customized RTE 13 + (type mismatch) if the argument is not a 2-D Array. + + +.. toctree:: + :maxdepth: 1 + +