From af16680a6c363e0fb59a7f6bc173a8796392cf48 Mon Sep 17 00:00:00 2001 From: Omkar Phansopkar Date: Sat, 14 Oct 2023 15:32:14 +0530 Subject: [PATCH] Updated config for readthedocs deploys Signed-off-by: Omkar Phansopkar --- docs/.readthedocs.yml => .readthedocs.yml | 17 ++--- CODE_OF_CONDUCT.rst | 86 +++++++++++++++++++++++ LICENSE => apache-2.0.LICENSE | 0 pyproject.toml | 16 +++++ 4 files changed, 109 insertions(+), 10 deletions(-) rename docs/.readthedocs.yml => .readthedocs.yml (80%) create mode 100644 CODE_OF_CONDUCT.rst rename LICENSE => apache-2.0.LICENSE (100%) create mode 100644 pyproject.toml diff --git a/docs/.readthedocs.yml b/.readthedocs.yml similarity index 80% rename from docs/.readthedocs.yml rename to .readthedocs.yml index be0c8060..7959d74c 100644 --- a/docs/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,12 +5,6 @@ # Required version: 2 -# Build in latest ubuntu/python -build: - os: ubuntu-22.04 - tools: - python: "3.11" - # Build PDF & ePub formats: - epub @@ -20,10 +14,13 @@ formats: sphinx: configuration: docs/source/conf.py +# specify build OS +build: + os: ubuntu-22.04 + tools: + python: "3.11" + # Setting the python version and doc build requirements python: install: - - method: pip - path: . - extra_requirements: - - docs \ No newline at end of file + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/CODE_OF_CONDUCT.rst b/CODE_OF_CONDUCT.rst new file mode 100644 index 00000000..00e8bc81 --- /dev/null +++ b/CODE_OF_CONDUCT.rst @@ -0,0 +1,86 @@ +Contributor Covenant Code of Conduct +==================================== + +Our Pledge +---------- + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our +project and our community a harassment-free experience for everyone, +regardless of age, body size, disability, ethnicity, gender identity and +expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +Our Standards +------------- + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual + attention or advances +- Trolling, insulting/derogatory comments, and personal or political + attacks +- Public or private harassment +- Publishing others’ private information, such as a physical or + electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +Our Responsibilities +-------------------- + +Project maintainers are responsible for clarifying the standards of +acceptable behavior and are expected to take appropriate and fair +corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, +or reject comments, commits, code, wiki edits, issues, and other +contributions that are not aligned to this Code of Conduct, or to ban +temporarily or permanently any contributor for other behaviors that they +deem inappropriate, threatening, offensive, or harmful. + +Scope +----- + +This Code of Conduct applies both within project spaces and in public +spaces when an individual is representing the project or its community. +Examples of representing a project or community include using an +official project e-mail address, posting via an official social media +account, or acting as an appointed representative at an online or +offline event. Representation of a project may be further defined and +clarified by project maintainers. + +Enforcement +----------- + +Instances of abusive, harassing, or otherwise unacceptable behavior may +be reported by contacting the project team at pombredanne@gmail.com +or on the Gitter chat channel at https://gitter.im/aboutcode-org/discuss . +All complaints will be reviewed and investigated and will result in a +response that is deemed necessary and appropriate to the circumstances. +The project team is obligated to maintain confidentiality with regard to +the reporter of an incident. Further details of specific enforcement +policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in +good faith may face temporary or permanent repercussions as determined +by other members of the project’s leadership. + +Attribution +----------- + +This Code of Conduct is adapted from the `Contributor Covenant`_ , +version 1.4, available at +https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +.. _Contributor Covenant: https://www.contributor-covenant.org \ No newline at end of file diff --git a/LICENSE b/apache-2.0.LICENSE similarity index 100% rename from LICENSE rename to apache-2.0.LICENSE diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..2dccb73d --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,16 @@ +[build-system] +requires = ["setuptools >= 50", "wheel", "setuptools_scm[toml] >= 6"] +build-backend = "setuptools.build_meta" + +[tool.setuptools_scm] +# this is used populated when creating a git archive +# and when there is .git dir and/or there is no git installed +fallback_version = "9999.$Format:%h-%cs$" + +python_files = "*.py" + +addopts = [ + "-rfExXw", + "--strict-markers", + "--doctest-modules" +] \ No newline at end of file