-
-
Notifications
You must be signed in to change notification settings - Fork 6.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature/docsv1 #554
Merged
Merged
Feature/docsv1 #554
Changes from all commits
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
ea6081b
Initial Docs Setup
amjadraza 5dc0b98
.gitignore updated with docs
amjadraza b75be71
Added Guide to Build Sphnix Docs
amjadraza 63fc136
Fixed typo
amjadraza 98bfa96
Added `.readthedocs.yaml` and `docs/requirements.txt` files
amjadraza 0de1761
redundant extension removed
amjadraza 9d36944
updated `docs/requirements.txt`
amjadraza df1a426
Added Respository Stats
amjadraza 019e7c3
Added RESULTS.md of Benchmark
amjadraza d88aa0d
Typo fixed
amjadraza 9bb5485
Fixed local installation and typos
amjadraza ebc2a51
Update README.md (#561)
elsatch fcbefbc
Update FUNDING.yml
AntonOsika 0e1405e
Update FUNDING.yml
AntonOsika 67a25db
Update FUNDING.yml
AntonOsika da0ee62
Update FUNDING.yml
AntonOsika b74f8da
Update FUNDING.yml
AntonOsika bbe77e0
Added DISCLAIMER in docs
amjadraza 6e14830
Instructions to build Docs added
amjadraza 6ad691e
added `doc` dependencies in `pyproject.toml` file using PEP621
amjadraza 54ff68f
added command to install `docs` dependencies
amjadraza 4d6196e
Fixed Links for `.md` files
amjadraza 9ac7850
updated the instructions
amjadraza File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# These are supported funding model platforms | ||
|
||
github: [antonosika] | ||
patreon: gpt-engineer | ||
patreon: user?u=2497970 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# .readthedocs.yaml | ||
# 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-22.04 | ||
tools: | ||
python: "3.11" | ||
# You can also specify other tool versions: | ||
# nodejs: "19" | ||
# rust: "1.64" | ||
# golang: "1.19" | ||
|
||
# Build documentation in the "docs/" directory with Sphinx | ||
sphinx: | ||
configuration: docs/conf.py | ||
|
||
# Optionally build your docs in additional formats such as PDF and ePub | ||
# formats: | ||
# - epub | ||
|
||
# Optional 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
Building Docs with Sphinx | ||
========================= | ||
|
||
This example shows a basic Sphinx docs project with Read the Docs. This project is using `sphinx` with `readthedocs` | ||
project template. | ||
|
||
Some useful links are given below to lear and contribute in the project. | ||
|
||
📚 [docs/](https://www.sphinx-doc.org/en/master/usage/quickstart.html)<br> | ||
A basic Sphinx project lives in `docs/`, it was generated using Sphinx defaults. All the `*.rst` & `*.md` make up sections in the documentation. Both `.rst` and `.md` formats are supported in this project | ||
|
||
⚙️ [.readthedocs.yaml](https://docs.readthedocs.io/en/stable/config-file/v2.html)<br> | ||
Read the Docs Build configuration is stored in `.readthedocs.yaml`. | ||
|
||
|
||
📍 [docs/requirements.txt](https://docs.readthedocs.io/en/stable/config-file/v2.html)<br> | ||
Python dependencies are [pinned](https://docs.readthedocs.io/en/latest/guides/reproducible-builds.html) (uses [pip-tools](https://pip-tools.readthedocs.io/en/latest/)) here. Make sure to add your Python dependencies to `requirements.txt` or if you choose [pip-tools](https://pip-tools.readthedocs.io/en/latest/), edit `docs/requirements.txt`. | ||
|
||
|
||
|
||
Example Project usage | ||
--------------------- | ||
|
||
`Poetry` is the package manager for `gpt-engineer`. In order to build documentation, we have to add docs requirements in | ||
development environment. | ||
|
||
This project has a standard readthedocs layout which is built by Read the Docs almost the same way that you would build it | ||
locally (on your own laptop!). | ||
|
||
You can build and view this documentation project locally - we recommend that you activate a `poetry` or your choice of `venv` | ||
and dependency management tool. | ||
|
||
Update `repository_stats.md` file under `docs/intro` | ||
|
||
```console | ||
# Install required Python dependencies (MkDocs etc.) | ||
pip install -e .[doc] | ||
cd docs/ | ||
# Create the `api_reference.rst` | ||
python create_api_rst.py | ||
|
||
# Build the docs | ||
make html | ||
``` | ||
|
||
Project Docs Structure | ||
---------------------- | ||
If you are new to Read the Docs, you may want to refer to the [Read the Docs User documentation](https://docs.readthedocs.io/). | ||
|
||
Below is the rundown of documentation structure for `pandasai`, you need to know: | ||
|
||
1. place your `docs/` folder alongside your Python project. | ||
2. copy `.readthedocs.yaml` and the `docs/` folder into your project root. | ||
3. `docs/api_reference.rst` contains the API documentation created using `docstring`. Run the `create_api_rst.py` to update the API reference file. | ||
4. Project is using standard Google Docstring Style. | ||
5. Rebuild the documenation locally to see that it works. | ||
6. Documentation are hosted on [Read the Docs tutorial](https://docs.readthedocs.io/en/stable/tutorial/) | ||
|
||
|
||
Read the Docs tutorial | ||
---------------------- | ||
|
||
To get started with Read the Docs, you may also refer to the | ||
[Read the Docs tutorial](https://docs.readthedocs.io/en/stable/tutorial/). I | ||
|
||
With every release, build the documentation manually. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Minimal makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line. | ||
SPHINXOPTS = | ||
SPHINXBUILD = python -msphinx | ||
SPHINXPROJ = gpt_engineer | ||
SOURCEDIR = . | ||
BUILDDIR = _build | ||
|
||
# Put it first so that "make" without argument is like "make help". | ||
help: | ||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
||
.PHONY: help Makefile | ||
|
||
# Catch-all target: route all unknown targets to Sphinx using the new | ||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
%: Makefile | ||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Benchmarks | ||
|
||
```bash | ||
python scripts/benchmark.py | ||
``` | ||
|
||
## 2023-06-21 | ||
|
||
| Benchmark | Ran | Works | Perfect | | ||
|--------------------|-----|-------|---------| | ||
| currency_converter | ✅ | ❌ | ❌ | | ||
| image_resizer | ✅ | ✅ | ✅ | | ||
| pomodoro_timer | ✅ | ✅ | ✅ | | ||
| url_shortener | ✅ | ✅ | ✅ | | ||
| file_explorer | ✅ | ✅ | ✅ | | ||
| markdown_editor | ✅ | ✅ | ❌ | | ||
| timer_app | ✅ | ❌ | ❌ | | ||
| weather_app | ✅ | ✅ | ✅ | | ||
| file_organizer | ✅ | ✅ | ✅ | | ||
| password_generator | ✅ | ✅ | ✅ | | ||
| todo_list | ✅ | ✅ | ✅ | | ||
|
||
## Notes on the errors | ||
|
||
Most errors come from that the "generate entrypoint" are incorrect. Ignoring | ||
those, we get 8/11 fully correct. | ||
|
||
All errors are very easy to fix. | ||
|
||
One error was trying to modify a constant. | ||
One error was that the html template was not fully filled in. | ||
One error is that a dependency was used incorrectly and easy to fix | ||
|
||
## 2023-06-19 | ||
|
||
| Benchmark | Ran | Works | Perfect | | ||
|--------------------|-----|-------|---------| | ||
| currency_converter | ❌ | ❌ | ❌ | | ||
| image_resizer | ✅ | ❌ | ❌ | | ||
| pomodoro_timer | ❌ | ❌ | ❌ | | ||
| url_shortener | ❌ | ❌ | ❌ | | ||
| file_explorer | ✅ | ✅ | ✅ | | ||
| markdown_editor | ❌ | ❌ | ❌ | | ||
| timer_app | ✅ | ❌ | ❌ | | ||
| weather_app | ❌ | ❌ | ❌ | | ||
| file_organizer | ✅ | ✅ | ✅ | | ||
| password_generator | ✅ | ✅ | ✅ | | ||
| todo_list | ✅ | ❌ | ❌ | | ||
|
||
## Notes on the errors | ||
|
||
**timer_app** almost works with unit tests config | ||
|
||
- failure mode: undefined import/conflicting names | ||
|
||
**file_explorer** works | ||
|
||
**file organiser**: works | ||
|
||
**image_resizer** almost works with unit tests config | ||
|
||
- failure mode: undefined import | ||
|
||
**todo_list** runs. doesn't really work with unit tests config | ||
Uncaught ReferenceError: module is not defined | ||
|
||
- failure mode: placeholder text | ||
|
||
url_shortener starts but gets the error: | ||
SQLite objects created in a thread can only be used in that same thread. The object was created in thread id 8636125824 and this is thread id 13021003776. | ||
|
||
markdown_editor: | ||
failing tests, 'WebDriver' object has no attribute 'find_element_by_id' | ||
|
||
pomodoro: doesn't run it only tests | ||
|
||
currency_converter: backend doesn't return anything | ||
|
||
weather_app only runs test, no code existed |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this legit?