Compile to HTML: Set Up Sphinx

Explore how to install and set up Sphinx for documenting Python code, including creating project directories and activating useful extensions like autodoc, to effectively produce and organize documentation.

We'll cover the following...

Installing Sphinx
Creating the project directory
Try it yourself

Installing Sphinx

To use Sphinx, we first need to install it using the following command in the terminal.

export LC_ALL=C.UTF-8 && export LANG=C.UTF-8
pipenv install --dev sphinx

Note: Here, it’s already been installed.

Sphinx comes with the tools sphinx-quickstart, sphinx-autogen, sphinx-build ...

1.Introduction

2.Basic Client Pages with React

3.Dynamic Client-Side Pages with React

4.Server-Side API Creation with Flask

5.Database Definition and Creation with SQLAlchemy

6.Code Documentation with Sphinx

7.An Introduction to Code Testing

8.UI Testing

9.API Testing

10.Database Integrity Testing

11.Automatically Testing Every Update

12.Design a Web Application

13.Build the Data Model

14.Build the REST API

15.Build the React Client

16.Finishing Touches for the App

17.Web Authentication

18.Deploy the Application

Project

19.Conclusion

20.Appendix

Compile to HTML: Set Up Sphinx

Installing Sphinx