Merge branch 'main' into documentation

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

@@ -0,0 +1,68 @@
+name: "🐛 Bug Report"
+description: Create a new ticket for a bug.
+title: "BUG: <title>"
+labels: [
+  "bug"
+]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      description: Please enter an explicit description of your issue
+      placeholder: Short and explicit description of your incident...
+    validations:
+      required: true
+  - type: textarea
+    id: reprod
+    attributes:
+      label: "Reproduction steps"
+      description: Please enter an explicit description of your issue
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+      render: bash
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: "Logs"
+      description: Please copy and paste any relevant log output or error messages. This will be automatically formatted into code, so no need for backticks.
+      render: bash
+    validations:
+      required: false
+  - type: textarea
+    id: package-version
+    attributes:
+      label: "Package Version"
+      description: What version of the package are you using?
+      placeholder: 1.0.0
+    validations:
+      required: false
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: "Python Version"
+      description: Which python version are you using?
+      multiple: true
+      options:
+        - 3.10
+        - 3.11
+        - 3.12
+    validations:
+      required: false
+  - type: dropdown
+    id: os
+    attributes:
+      label: "OS"
+      description: What is the impacted environment ?
+      multiple: true
+      options:
+        - Windows
+        - Linux
+        - Mac
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

@@ -0,0 +1,39 @@
+name: "Feature Request"
+description: Create a new ticket for a new feature request
+title: "REQUEST: - <title>"
+labels: [
+  "enhancement"
+]
+body:
+  - type: textarea
+    id: summary
+    attributes:
+      label: "Summary"
+      description: Provide a brief explanation of the feature
+      placeholder: Describe in a few lines your feature request
+    validations:
+      required: true
+  - type: textarea
+    id: basic_example
+    attributes:
+      label: "Basic Example"
+      description: Indicate here some basic examples of your feature.
+      placeholder: A few specific words about your feature request.
+    validations:
+      required: true
+  - type: textarea
+    id: reference_issues
+    attributes:
+      label: "Reference Issues"
+      description: Common issues
+      placeholder: "#Issues IDs"
+    validations:
+      required: false
+  - type: textarea
+    id: unresolved_question
+    attributes:
+      label: "Unresolved questions"
+      description: What questions still remain unresolved ?
+      placeholder: Identify any unresolved issues.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

docs/_templates/autosummary/class.rst

@@ -0,0 +1,19 @@
+{{ fullname | escape | underline}}
+
+{{ module }}
+
+{{ objname }}
+
+{% block attributes %} {% if attributes %} .. rubric:: Attributes
+
+{% for item in attributes %}
+~{{ fullname }}.{{ item }}
+
+{%- endfor %} {% endif %} {% endblock %}
+
+{% block methods %} {% if methods %} .. rubric:: Methods
+
+{% for item in methods %}
+{%- if item != '__init__' %} ~{{ fullname }}.{{ item }} {%- endif -%}
+
+{%- endfor %} {% endif %} {% endblock %}

docs/_templates/autosummary/function.rst

@@ -0,0 +1,3 @@
+{{ fullname | escape | underline}}
+
+{{ module }}

docs/api.rst

@@ -0,0 +1,8 @@
+API Docs
+========
+
+.. autosummary::
+    :toctree: generated
+    :recursive:
+
+    co2calculator

docs/conf.py

@@ -43,12 +43,16 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.autosectionlabel",
     "sphinx.ext.viewcode",
+    "sphinx.ext.autosummary",
     "myst_parser",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
+# generate autosummary
+autosummary_generate = True
+
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.

docs/index.rst

@@ -23,6 +23,7 @@ Contents
    calculate/heating
    calculate/electricity
    calculate/emission_factors
+   api
 
 Indices and tables
 ==================