Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-19 21:25:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #469 from 5h0ov/patch-1

Browse Source 
Update How-to-train-on-other-documentation.md
This commit is contained in:
Alex 2023-10-08 19:40:54 +01:00 committed by GitHub
commit 2e076ef3f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/pages/Guides/How-to-train-on-other-documentation.md
View File

@ -12,9 +12,9 @@ It currently uses OPEN_AI to create vector store, so make sure your documentatio
You can usually find documentation on github in `docs/` folder for most open-source projects. You can usually find documentation on github in `docs/` folder for most open-source projects.
### 1. Find documentation in .rst/.md and create a folder with it in your scripts directory ### 1. Find documentation in .rst/.md and create a folder with it in your scripts directory
Name it `inputs/` - Name it `inputs/`
Put all your .rst/.md files in there - Put all your .rst/.md files in there
The search is recursive, so you don't need to flatten them - The search is recursive, so you don't need to flatten them
If there are no .rst/.md files just convert whatever you find to txt and feed it. (don't forget to change the extension in script) If there are no .rst/.md files just convert whatever you find to txt and feed it. (don't forget to change the extension in script)
@ -56,4 +56,4 @@ You can learn more about options while running ingest.py by running:
| | | | | |
| **convert** | Creates documentation in .md format from source code | | **convert** | Creates documentation in .md format from source code |
| --dir TEXT | Path to a directory with source code. E.g. --dir inputs [default: inputs] | | --dir TEXT | Path to a directory with source code. E.g. --dir inputs [default: inputs] |
| --formats TEXT | Source code language from which to create documentation. Supports py, js and java. E.g. --formats py [default: py] | | --formats TEXT | Source code language from which to create documentation. Supports py, js and java. E.g. --formats py [default: py] |