There are two writing methods:
- In restructuredtext
- In markdown
In restructuredtext
Tool: Pip installSph?sph=-Autobuild
Clone Your repository to local: git clone https://github.com/yourusername/yourrepository.git
Create a document in the repository root directory:
Mkdir docs & CD docs
Sphinx-Quickstart // follow the prompts to generate index. rst and Conf. py, and some other directories and files.
Edit the index. rst File
Contents:
Indices and tables
And so on
Compile the HTML file make HTML
Upload the local repository to GitHub git push // enter the account and password
Register and log on to read the docs
Set-connected to GitHub // associate with the GitHub account
Start importing documents
Import a project // The repository name on GitHub is automatically listed. If not, you can import the repository name manually.
Follow the prompts to create the instance.
Create a document for the GitHub Project