Skip to content

Commit

Permalink
Merge pull request #555 from vprusso/224-simplify-gitignore
Browse files Browse the repository at this point in the history
Simplifying gitignore file.
  • Loading branch information
vprusso authored Apr 22, 2024
2 parents edabffd + 446be8b commit a040822
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 113 deletions.
123 changes: 16 additions & 107 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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/*
12 changes: 6 additions & 6 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -186,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.


---------------------
Expand Down

0 comments on commit a040822

Please sign in to comment.