ReadTheDocs

Small changes - directly edit the file on GitHub and do a pull request

Large changes - use a local method to build and test your changes before doing a pull request

LOCAL METHODS:

1. normal fork/clone:

fork and clone your fork locally

using any editor open the docs file and edit the code

open a terminal in the "docs" directory and install the required libraries pip install -r requirements.txt

open a terminal in the "docs" directory and run make html to build the docs

open index.html in the "build\html\index.html" with your favorite internet browser to verify your changes are correctly done

commit and push and do a request as usual

---

2. sparse clone/checkout:

If the clone takes too long or you would rather have a clean local directory just for editing docs

requires git version 2.25 or higher use git version to check your version if the sparse-checkout command throws an error you should update git or use the second method

sparse clone and configure the sparse-checkout file to only look at the docs directory

(use your fork instead of the real repo when cloning)

 git clone --sparse https://github.com/hoffstadt/DearPyGui.git DearPyGui.docs

 cd DearPyGui.Docs

 git sparse-checkout set docs

using any editor open the docs file and edit the code

open a terminal in the "DearPyGui.docs\docs" directory and install the required libraries pip install -r requirements.txt

open a terminal in the "DearPyGui.docs\docs" directory and run make html to build the docs

open index.html in the "build\html\index.html" with your favorite internet browser to verify your changes are correctly done

commit and push and do a request as usual