Skip to content

Commit

Permalink
DOC: Misc progress. Some methods defined.
Browse files Browse the repository at this point in the history
Probably going to have/want to cope with a messy system for
 external references, just adding custom things in epilogs.
 Looking into a custom role/domain/whatever, but it's going to be
 a lot of figuring-out to get it up and running. The manual layout
 of an objects.inv promises to be somewhat annoying, too.
  • Loading branch information
bskinn committed May 16, 2016
1 parent a9e8a09 commit 4ec3bf0
Show file tree
Hide file tree
Showing 10 changed files with 77 additions and 7 deletions.
7 changes: 7 additions & 0 deletions 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*

5 changes: 5 additions & 0 deletions 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

12 changes: 12 additions & 0 deletions 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


15 changes: 14 additions & 1 deletion doc/source/conf.py
Expand Up @@ -31,6 +31,7 @@
# ones.
extensions = [
'sphinx.ext.mathjax',
'sphinx.ext.intersphinx',
# 'sphinx.ext.autodoc',
# 'sphinx.ext.napoleon'
]
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 ----------------------------------------------

Expand Down Expand Up @@ -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')
# }
5 changes: 3 additions & 2 deletions doc/source/index.rst
Expand Up @@ -22,6 +22,7 @@ Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. * :ref:`modindex`
.. * :ref:`search`
3 changes: 3 additions & 0 deletions doc/source/udf/index.rst
Expand Up @@ -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::
Expand Down
13 changes: 10 additions & 3 deletions doc/source/udf/matrix.rst
Expand Up @@ -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::
Expand Down
2 changes: 1 addition & 1 deletion doc/source/vba/assert.rst
Expand Up @@ -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.


Expand Down
1 change: 1 addition & 0 deletions doc/source/vba/index.rst
Expand Up @@ -11,5 +11,6 @@ Contents:
:maxdepth: 1

assert
matrix


21 changes: 21 additions & 0 deletions 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 <udf-mtx-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


0 comments on commit 4ec3bf0

Please sign in to comment.