Skip to content

Commit

Permalink
Updating docs (#330)
Browse files Browse the repository at this point in the history
  • Loading branch information
apetenchea committed Mar 11, 2024
1 parent ed35c9d commit 3e43b36
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
sys.path.insert(0, os.path.abspath(".."))

project = "python-arango"
copyright = "2016-2022, Joohwan Oh"
copyright = "2016-2024, Joohwan Oh"
author = "Joohwan Oh"
extensions = [
"sphinx_rtd_theme",
Expand Down
12 changes: 5 additions & 7 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ Requirements
Before submitting a pull request on GitHub_, please make sure you meet the
following requirements:

* The pull request points to dev_ branch.
* The pull request points to main_ branch.
* Changes are squashed into a single commit. I like to use git rebase for this.
* Commit message is in present tense. For example, "Fix bug" is good while
"Fixed bug" is not.
* Sphinx_-compatible docstrings.
* PEP8_ compliance.
* No missing docstrings or commented-out lines.
* Test coverage_ remains at %100. If a piece of code is trivial and does not
* Test coverage remains at %100. If a piece of code is trivial and does not
need unit tests, use this_ to exclude it from coverage.
* No build failures on `Travis CI`_. Builds automatically trigger on pull
* No build failures. Builds automatically trigger on pull
request submissions.
* Documentation is kept up-to-date with the new changes (see below).

Expand Down Expand Up @@ -88,12 +88,10 @@ Sphinx_. To build an HTML version on your local machine:
As always, thank you for your contribution!

.. _dev: https://github.com/joowani/python-arango/tree/dev
.. _GitHub: https://github.com/joowani/python-arango
.. _main: https://github.com/arangodb/python-arango/tree/main
.. _GitHub: https://github.com/arangodb/python-arango
.. _PEP8: https://www.python.org/dev/peps/pep-0008/
.. _coverage: https://coveralls.io/github/joowani/python-arango
.. _this: http://coverage.readthedocs.io/en/latest/excluding.html
.. _Travis CI: https://travis-ci.org/joowani/python-arango
.. _Sphinx: https://github.com/sphinx-doc/sphinx
.. _flake8: http://flake8.pycqa.org
.. _here: http://flake8.pycqa.org/en/latest/user/violations.html#in-line-ignoring-errors
Expand Down

0 comments on commit 3e43b36

Please sign in to comment.