diff --git a/.gitignore b/.gitignore index efe2784..1a1fde0 100644 --- a/.gitignore +++ b/.gitignore @@ -102,5 +102,4 @@ ENV/ debug/ log/ -docs/ *dump.json diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fd16ba2..8e71baf 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,3 +8,6 @@ repos: - id: end-of-file-fixer - id: check-yaml - id: check-added-large-files + +default_language_version: + python: python3.7 diff --git a/LICENSE b/LICENSE index 3da5ee4..3b5eaf6 100644 --- a/LICENSE +++ b/LICENSE @@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - diff --git a/README.rst b/README.rst index 3b3c4ff..d54d47d 100644 --- a/README.rst +++ b/README.rst @@ -34,4 +34,3 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage - diff --git a/docs/erepublik.rst b/docs/erepublik.rst new file mode 100644 index 0000000..dd3ab8f --- /dev/null +++ b/docs/erepublik.rst @@ -0,0 +1,53 @@ +erepublik package +================= + +Submodules +---------- + +erepublik.access\_points module +------------------------------- + +.. automodule:: erepublik.access_points + :members: + :undoc-members: + :show-inheritance: + +erepublik.citizen module +------------------------ + +.. automodule:: erepublik.citizen + :members: + :undoc-members: + :show-inheritance: + +erepublik.classes module +------------------------ + +.. automodule:: erepublik.classes + :members: + :undoc-members: + :show-inheritance: + +erepublik.constants module +-------------------------- + +.. automodule:: erepublik.constants + :members: + :undoc-members: + :show-inheritance: + +erepublik.utils module +---------------------- + +.. automodule:: erepublik.utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: erepublik + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 0000000..6abce06 --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +erepublik +========= + +.. toctree:: + :maxdepth: 4 + + erepublik diff --git a/docs/usage.rst b/docs/usage.rst index 027cd12..a65fac4 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -7,4 +7,3 @@ To use eRepublik script in a project:: from erepublik import Citizen player = Citizen('email@domain.com', 'password') player.update_all() -