From 6af1ca718a2e57d9f9d42d3cbb5b39246a9a0166 Mon Sep 17 00:00:00 2001 From: Ashley Whetter Date: Sun, 23 Oct 2022 14:12:22 -0700 Subject: [PATCH] Remove some autogenerated test data --- .gitignore | 2 + CHANGELOG.rst | 4 + .../pyexample/autoapi/example/index.rst | 185 ---------------- .../pymovedconfpy/autoapi/example/index.rst | 207 ------------------ 4 files changed, 6 insertions(+), 392 deletions(-) delete mode 100644 tests/python/pyexample/autoapi/example/index.rst delete mode 100644 tests/python/pymovedconfpy/autoapi/example/index.rst diff --git a/.gitignore b/.gitignore index c86c4a9..a6137f2 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,5 @@ _api_ .pytest_cache/ build/ dist/ +tests/python/pyexample/autoapi/example/index.rst +tests/python/pymovedconfpy/autoapi/example/index.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 5ada5df..ea5a9fd 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -11,6 +11,10 @@ Bug Fixes * `#330 `: (Python) Render tuple values as tuples, not lists. +Trivial/Internal Changes +^^^^^^^^^^^^^^^^^^^^^^^^ +* Removed some autogenerated test data from the repository. + v2.0.0 (2022-09-27) ------------------- diff --git a/tests/python/pyexample/autoapi/example/index.rst b/tests/python/pyexample/autoapi/example/index.rst deleted file mode 100644 index 2d6946b..0000000 --- a/tests/python/pyexample/autoapi/example/index.rst +++ /dev/null @@ -1,185 +0,0 @@ -:py:mod:`example` -================= - -.. py:module:: example - -.. autoapi-nested-parse:: - - Example module - - This is a description - - - -Module Contents ---------------- - -Classes -~~~~~~~ - -.. autoapisummary:: - - example.Foo - example.Bar - example.ClassWithNoInit - example.One - example.MultilineOne - example.Two - - - -Functions -~~~~~~~~~ - -.. autoapisummary:: - - example.decorator_okay - example.fn_with_long_sig - - - -.. py:class:: Foo(attr) - - Bases: :py:obj:`object` - - This is using custom filters. - .. py:class:: Meta - - Bases: :py:obj:`object` - - This is using custom filters. - .. py:method:: foo() - :classmethod: - - The foo class method - - - - .. py:property:: property_simple - :type: int - - This property should parse okay. - - - .. py:attribute:: class_var - :annotation: = 42 - - - - .. py:attribute:: another_class_var - :annotation: = 42 - - Another class var docstring - - - .. py:attribute:: attr2 - - - This is the docstring of an instance attribute. - - :type: str - - - .. py:method:: method_okay(foo=None, bar=None) - - This method should parse okay - - - .. py:method:: method_multiline(foo=None, bar=None, baz=None) - - This is on multiple lines, but should parse okay too - - pydocstyle gives us lines of source. Test if this means that multiline - definitions are covered in the way we're anticipating here - - - .. py:method:: method_tricky(foo=None, bar=dict(foo=1, bar=2)) - - This will likely fail our argument testing - - We parse naively on commas, so the nested dictionary will throw this off - - - .. py:method:: method_sphinx_docs(foo, bar=0) - - This method is documented with sphinx style docstrings. - - :param foo: The first argument. - :type foo: int - - :param int bar: The second argument. - - :returns: The sum of foo and bar. - :rtype: int - - - .. py:method:: method_google_docs(foo, bar=0) - - This method is documented with google style docstrings. - - Args: - foo (int): The first argument. - bar (int): The second argument. - - Returns: - int: The sum of foo and bar. - - - .. py:method:: method_sphinx_unicode() - - This docstring uses unicodé. - - :returns: A string. - :rtype: str - - - .. py:method:: method_google_unicode() - - This docstring uses unicodé. - - Returns: - str: A string. - - - -.. py:function:: decorator_okay(func) - - This decorator should parse okay. - - -.. py:class:: Bar(attr) - - Bases: :py:obj:`Foo` - - This is using custom filters. - .. py:method:: method_okay(foo=None, bar=None) - - This method should parse okay - - - -.. py:class:: ClassWithNoInit - - This is using custom filters. - -.. py:class:: One - - This is using custom filters. - -.. py:class:: MultilineOne - - Bases: :py:obj:`One` - - This is using custom filters. - -.. py:class:: Two - - Bases: :py:obj:`One` - - This is using custom filters. - -.. py:function:: fn_with_long_sig(this, *, function=None, has=True, quite=True, a, long, signature, many, keyword, arguments) - - A function with a long signature. - - diff --git a/tests/python/pymovedconfpy/autoapi/example/index.rst b/tests/python/pymovedconfpy/autoapi/example/index.rst deleted file mode 100644 index 0896e07..0000000 --- a/tests/python/pymovedconfpy/autoapi/example/index.rst +++ /dev/null @@ -1,207 +0,0 @@ -:py:mod:`example` -================= - -.. py:module:: example - -.. autoapi-nested-parse:: - - Example module - - This is a description - - - -Module Contents ---------------- - -Classes -~~~~~~~ - -.. autoapisummary:: - - example.Foo - example.Bar - example.ClassWithNoInit - example.One - example.MultilineOne - example.Two - - - -Functions -~~~~~~~~~ - -.. autoapisummary:: - - example.decorator_okay - example.fn_with_long_sig - - - -.. py:class:: Foo(attr) - - Bases: :py:obj:`object` - - Can we parse arguments from the class docstring? - - :param attr: Set an attribute. - :type attr: str - - Constructor docstring - - .. py:class:: Meta - - Bases: :py:obj:`object` - - A nested class just to test things out - - .. py:method:: foo() - :classmethod: - - The foo class method - - - - .. py:property:: property_simple - :type: int - - This property should parse okay. - - - .. py:attribute:: class_var - :annotation: = 42 - - - - .. py:attribute:: another_class_var - :annotation: = 42 - - Another class var docstring - - - .. py:attribute:: attr2 - - - This is the docstring of an instance attribute. - - :type: str - - - .. py:method:: method_okay(foo=None, bar=None) - - This method should parse okay - - - .. py:method:: method_multiline(foo=None, bar=None, baz=None) - - This is on multiple lines, but should parse okay too - - pydocstyle gives us lines of source. Test if this means that multiline - definitions are covered in the way we're anticipating here - - - .. py:method:: method_tricky(foo=None, bar=dict(foo=1, bar=2)) - - This will likely fail our argument testing - - We parse naively on commas, so the nested dictionary will throw this off - - - .. py:method:: method_sphinx_docs(foo, bar=0) - - This method is documented with sphinx style docstrings. - - :param foo: The first argument. - :type foo: int - - :param int bar: The second argument. - - :returns: The sum of foo and bar. - :rtype: int - - - .. py:method:: method_google_docs(foo, bar=0) - - This method is documented with google style docstrings. - - Args: - foo (int): The first argument. - bar (int): The second argument. - - Returns: - int: The sum of foo and bar. - - - .. py:method:: method_sphinx_unicode() - - This docstring uses unicodé. - - :returns: A string. - :rtype: str - - - .. py:method:: method_google_unicode() - - This docstring uses unicodé. - - Returns: - str: A string. - - - -.. py:function:: decorator_okay(func) - - This decorator should parse okay. - - -.. py:class:: Bar(attr) - - Bases: :py:obj:`Foo` - - Can we parse arguments from the class docstring? - - :param attr: Set an attribute. - :type attr: str - - Constructor docstring - - .. py:method:: method_okay(foo=None, bar=None) - - This method should parse okay - - - -.. py:class:: ClassWithNoInit - - -.. py:class:: One - - One. - - One __init__. - - -.. py:class:: MultilineOne - - Bases: :py:obj:`One` - - This is a naughty summary line - that exists on two lines. - - One __init__. - - -.. py:class:: Two - - Bases: :py:obj:`One` - - Two. - - One __init__. - - -.. py:function:: fn_with_long_sig(this, *, function=None, has=True, quite=True, a, long, signature, many, keyword, arguments) - - A function with a long signature. - -