Unverified Commit bfbb36af authored by Duggan, John's avatar Duggan, John Committed by GitHub
Browse files

Merge pull request #130 from nova-model/doc_fix 

Fix literalinclude blocks from tests directory
parents b0918eef 9e0014ee

docs/api.rst

+2 −0
Original line number Diff line number Diff line
@@ -40,6 +40,8 @@ General Purpose Components 
    :members:

    :special-members: __new__



.. _api_remotefileinput:



.. autoclass:: nova.trame.view.components.RemoteFileInput

    :members:

    :special-members: __init__

docs/example_layouts.rst

+5 −5
Original line number Diff line number Diff line
@@ -9,7 +9,7 @@ GridLayout 
----------

By default, each item in a GridLayout will take up one row and one column. This can be changed by setting the row_span and column_span properties of the item.



.. literalinclude:: ../tests/gallery/app.py

.. literalinclude:: ../tests/gallery/views/app.py

    :start-after: grid row and column span example

    :end-before: grid row and column span example end

    :dedent:
@@ -25,7 +25,7 @@ GridLayout with whitespace 
--------------------------

Trying this with HBoxLayout or VBoxLayout will produce unpredictable behavior.



.. literalinclude:: ../tests/gallery/app.py

.. literalinclude:: ../tests/gallery/views/app.py

    :start-after: whitespace example

    :end-before: whitespace example end

    :dedent:
@@ -40,7 +40,7 @@ Result: 
HBoxLayout containing VBoxLayout

--------------------------------



.. literalinclude:: ../tests/gallery/app.py

.. literalinclude:: ../tests/gallery/views/app.py

    :start-after: mixed boxes example 1

    :end-before: mixed boxes example 1 end

    :dedent:
@@ -55,7 +55,7 @@ Result: 
VBoxLayout containing HBoxLayout

--------------------------------



.. literalinclude:: ../tests/gallery/app.py

.. literalinclude:: ../tests/gallery/views/app.py

    :start-after: mixed boxes example 2

    :end-before: mixed boxes example 2 end

    :dedent:
@@ -70,7 +70,7 @@ Result: 
GridLayout containing BoxLayouts

--------------------------------



.. literalinclude:: ../tests/gallery/app.py

.. literalinclude:: ../tests/gallery/views/app.py

    :start-after: mixed boxes example 3

    :end-before: mixed boxes example 3 end

    :dedent:

docs/working_with_trame.rst

+2 −2
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ If you want to customize a slot, you can either completely replace it or add chi 


If you want to add children to a slot, you can do the following:



.. literalinclude:: ../tests/gallery/app.py

.. literalinclude:: ../tests/gallery/views/app.py

    :start-after: slot child example

    :end-before: slot child example complete

    :dedent:
@@ -85,7 +85,7 @@ In order to use Vuetify helper classes in Trame, you can provide the `classes` a 


Example:



.. literalinclude:: ../tests/gallery/app.py

.. literalinclude:: ../tests/gallery/views/app.py

    :start-after: Vuetify class example start

    :end-before: Vuetify class example end

    :dedent:

src/nova/trame/view/components/input_field.py

+1 −1
Original line number Diff line number Diff line
@@ -172,7 +172,7 @@ class InputField: 
            The following example would set the auto_grow and label attributes on

            `VTextarea <https://trame.readthedocs.io/en/latest/trame.widgets.vuetify3.html#trame.widgets.vuetify3.VTextarea>`_:



            .. literalinclude:: ../tests/gallery/app.py

            .. literalinclude:: ../tests/gallery/views/app.py

                :start-after: InputField kwargs example start

                :end-before: InputField kwargs example end

                :dedent:

src/nova/trame/view/layouts/grid.py

+2 −2
Original line number Diff line number Diff line
@@ -53,7 +53,7 @@ class GridLayout(html.Div): 
        --------

        Basic usage:



        .. literalinclude:: ../tests/gallery/app.py

        .. literalinclude:: ../tests/gallery/views/app.py

            :start-after: setup grid

            :end-before: setup grid complete

            :dedent:
@@ -133,7 +133,7 @@ class GridLayout(html.Div): 


        Example

        -------

        .. literalinclude:: ../tests/gallery/app.py

        .. literalinclude:: ../tests/gallery/views/app.py

            :start-after: grid row and column span example

            :end-before: grid row and column span example end

            :dedent: