From 5fb761754675354e09e07a4098d40091e76a2375 Mon Sep 17 00:00:00 2001 From: vrusso Date: Sat, 20 Apr 2024 12:04:45 -0400 Subject: [PATCH 1/3] Simplifying gitignore file. --- .gitignore | 123 +++++++---------------------------------------------- 1 file changed, 16 insertions(+), 107 deletions(-) diff --git a/.gitignore b/.gitignore index 80f96e20f..3b48074df 100644 --- a/.gitignore +++ b/.gitignore @@ -1,110 +1,19 @@ -*.vscode* -*.DS_Store -*.lock -*.idea -*.pdf -*pip-wheel-metadata/ -main.py - -# Byte-compiled / optimized / DLL files +.DS_Store +.vscode +.python-version +.idea/ +.coverage +*.dat +*.ipynb +*.hdf5 +*.ipynb_checkpoints +*.jupyter_cache +_build __pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -env/ -build/ -develop-eggs/ +docs/build/ +toqito.egg-info/ dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -*.egg-info/ -.installed.cfg -*.egg - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.coverage -.coverage.* -.cache -nosetests.xml +build/ coverage.xml -*.cover -.hypothesis/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ -docs/docs/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# pyenv -.python-version - -# celery beat schedule file -celerybeat-schedule - -# SageMath parsed files -*.sage.py - -# dotenv -.env - -# virtualenv -.venv -venv/ -ENV/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ +jupyter_execute/ +venv/* From 261ae81a7c069a1042a39f29e1d6de017d061f0f Mon Sep 17 00:00:00 2001 From: vrusso Date: Sat, 20 Apr 2024 12:19:16 -0400 Subject: [PATCH 2/3] Fixing indentation error for contributing --- docs/contributing.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index df1756d3f..decf6722c 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -174,8 +174,9 @@ A standard document has to follow the :code:`.rst` format. For more information To use `doctest`: - Use `make doctest` in `toqito/docs` for the docstring examples to be verified. -- Use `pytest --doctest-glob=*.rst` to check the examples in all the `.rst` files in `toqito/docs` work as expected. If you would like to only - check the examples in a specific file, use `pytest --doctest-glob=tutorials.name_of_file.rst` instead. +- Use `pytest --doctest-glob=*.rst` to check the examples in all the `.rst` files in `toqito/docs` work as expected. If +you would like to only check the examples in a specific file, use `pytest --doctest-glob=tutorials.name_of_file.rst` +instead. -------------------- Adding a new feature From 446be8b1b2558e304832260b913c0e4e30bdb2d7 Mon Sep 17 00:00:00 2001 From: vrusso Date: Sat, 20 Apr 2024 12:19:20 -0400 Subject: [PATCH 3/3] Fixing indentation error for contributing --- docs/contributing.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index decf6722c..16be6a969 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -187,11 +187,10 @@ If you add a new feature to :code:`toqito`, make sure - The function docstring follows the style guidelines as specified in `References in Docstrings`_. - Added lines should show up as covered in the :code:`pytest` code coverage report. See `Testing`_. -- Code and tests for the new feature should follow the style guidelines as discussed in - `Code Style`_. +- Code and tests for the new feature should follow the style guidelines as discussed in `Code Style`_. - Finally, if the new feature is a new module, it has to be listed alphabetically as :code:`autoapi/new_module/index` in - :code:`autoapi_members.rst` available in the :code:`docs` folder. When Sphinx is run locally, the new module should - then appear to be listed in the :code:`API Reference` page. +:code:`autoapi_members.rst` available in the :code:`docs` folder. When Sphinx is run locally, the new module should then +appear to be listed in the :code:`API Reference` page. ---------------------