Get More reST: Adding Files

Explore how to expand your Python project documentation using Sphinx by installing a Markdown parser and including additional files. Understand how to configure Sphinx extensions, manage source files within the docs directory, and effectively use symbolic links or file copying to integrate files like README.md, changelogs, and acknowledgments. This lesson helps you create comprehensive, navigable documentation that reflects your full project structure.

We'll cover the following...

Installing Markdown parser
Adding some additional files

Installing Markdown parser

First, you will need to install the Markdown parser with the following command:

pipenv install --dev recommonmark

Note: It’s already installed here.

Then, modify the conf.py by adding recommonmark to the list of extensions. For example, you would change:

extensions =

...

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

Get More reST: Adding Files

Installing Markdown parser