Skip to content

Commit f2132aa

Browse files
authored
docs: add readthedocs for dbgpt project (#97)
Add readthedocs documents build.
2 parents d43a849 + d4bab66 commit f2132aa

File tree

5 files changed

+44
-58
lines changed

5 files changed

+44
-58
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ We provide a user interface for Gradio, which allows you to use DB-GPT through o
185185

186186
To use multiple models, modify the LLM_MODEL parameter in the .env configuration file to switch between the models.
187187

188-
####Create your own knowledge repository:
188+
### Create your own knowledge repository:
189189

190190
1.Place personal knowledge files or folders in the pilot/datasets directory.
191191

@@ -213,7 +213,7 @@ Run the Python interpreter and type the commands:
213213

214214
## Acknowledgement
215215

216-
The achievements of this project are thanks to the technical community, especially the following projects:
216+
This project is standing on the shoulders of giants and is not going to work without the open-source communities. Special thanks to the following projects for their excellent contribution to the AI industry:
217217
- [FastChat](https://github.com/lm-sys/FastChat) for providing chat services
218218
- [vicuna-13b](https://lmsys.org/blog/2023-03-30-vicuna/) as the base model
219219
- [langchain](https://langchain.readthedocs.io/) tool chain
@@ -245,4 +245,4 @@ This project follows the git-contributor [spec](https://github.com/xudafeng/git-
245245
The MIT License (MIT)
246246

247247
## Contact Information
248-
We are working on building a community, if you have any ideas about building the community, feel free to contact us. [Discord](https://discord.com/invite/twmZk3vv)
248+
We are working on building a community, if you have any ideas about building the community, feel free to contact us. [Discord](https://discord.gg/kMFf77FH)

docs/conf.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,14 @@
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

99
import toml
10+
import os
11+
import sys
1012

1113
project = "DB-GPT"
1214
copyright = "2023, csunny"
1315
author = "csunny"
1416

15-
with open("../pyproject.toml") as f:
16-
data = toml.load(f)
17-
18-
version = data["tool"]["poetry"]["version"]
19-
release = version
17+
version = "0.1.0"
2018
html_title = project + " " + version
2119

2220
# -- General configuration ---------------------------------------------------

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Use Cases
8989

9090
| Best Practices and built-in implementations for common DB-GPT use cases:
9191
92-
- `Sql generation and diagnosis <./use_cases/sql_generation_and_diagnosis.html>`: SQL generation and diagnosis.
92+
- `Sql generation and diagnosis <./use_cases/sql_generation_and_diagnosis.html>`_: SQL generation and diagnosis.
9393

9494
- `knownledge Based QA <./use_cases/knownledge_based_qa.html>`_: A important scene for user to chat with database documents, codes, bugs and schemas.
9595

pyproject.toml

Lines changed: 0 additions & 49 deletions
This file was deleted.

setup.py

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
from typing import List
2+
3+
import setuptools
4+
from setuptools import find_packages
5+
6+
with open("README.md", "r") as fh:
7+
long_description = fh.read()
8+
9+
10+
def parse_requirements(file_name: str) -> List[str]:
11+
with open(file_name) as f:
12+
return [
13+
require.strip() for require in f
14+
if require.strip() and not require.startswith('#')
15+
]
16+
17+
18+
setuptools.setup(
19+
name="DB-GPT",
20+
packages=find_packages(),
21+
version="0.1.0",
22+
author="csunny",
23+
author_email="[email protected]",
24+
description="DB-GPT is an experimental open-source project that uses localized GPT large models to interact with your data and environment."
25+
" With this solution, you can be assured that there is no risk of data leakage, and your data is 100% private and secure.",
26+
long_description=long_description,
27+
long_description_content_type="text/markdown",
28+
install_requires=parse_requirements('requirements.txt'),
29+
url="https://github.com/csunny/DB-GPT",
30+
license='https://opensource.org/license/mit/',
31+
python_requires='>=3.10',
32+
entry_points={
33+
'console_scripts': [
34+
'dbgpt_server=pilot.server:webserver',
35+
],
36+
},
37+
)

0 commit comments

Comments
 (0)