Feature/docsv1

[amjadraza]

GPT-ENGINEER : Documentations

The first stage of Docs for get-engineer project is included in this PR. The following have been done

First Stage

1. Set up sphinx based project documentation
2. Generating the Package API docs using a Python Script
3. Introduction about the Package
4. Both .rst and .md files structures supported
5. Re-Factored the pyproject.yml to incorporate docs dependencies.

After Merge to do

• Generate and Host Project Documentation on readthedocs server from main branch
• Close relevant issue.

Second Stage:

• Re-Factor the Package code to include the docstrings
• Add more information and tutorials on using gpt-engineer

@RareMojo thanks for your notes.

[amjadraza]

@AntonOsika please see, happy to discuss if needed.

[amjadraza]

@AntonOsika Fixed the Links issues.

[AntonOsika]

Looks good with the ../ linking to md files etc!

I'm getting this error when running make build:

[QML-Coder]

Is this legit?

[amjadraza]

Looks good with the ../ linking to md files etc!

I'm getting this error when running make build:

@AntonOsika did you install the dependencies? Looks like the theme package is not installed correctly. Check if the package is installed correctly.

I have created docs using the recent push.

https://gpt-engineer.readthedocs.io/en/latest/index.html

If installing manually, use the docs/requirements.txt file for the doc dependencies.

Thanks

[AntonOsika]

Great, it does work with requirements.txt

How about we only put the doc requirements in requirements.txt or in pyproject.toml, not both @amjadraza ?

[AntonOsika]

Hey @amjadraza .

I created a new venv and verified it does work!

Let's merge. 🎉

About the requirements.txt, should we keep it do you think?