Skip to content

Commit

Permalink
feat(added readthedoc)
Browse files Browse the repository at this point in the history
  • Loading branch information
khushaljethava committed Nov 29, 2024
1 parent b93f044 commit a314b8b
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
fakeinvoicegen.egg-info/
dist/
23 changes: 23 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version, and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.13"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py

# Optionally, but recommended,
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt

6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
setup(
name="fakeinvoicegen",
version="0.1.0",
author="Your Name",
author_email="your.email@example.com",
author="Khushal jethava",
author_email="khushaljethava14@outlook.com",
description="A package to generate fake invoices using Faker and InvoiceGenerator",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/yourusername/fakeinvoicegen",
url="https://github.com/Khushaljethava/fakeinvoicegen",
packages=find_packages(),
classifiers=[
"Development Status :: 3 - Alpha",
Expand Down

0 comments on commit a314b8b

Please sign in to comment.