Publish

Let's learn how to publish the documentation on GitHub.

We'll cover the following

Documentation
How to publish documentation

Documentation

Documentation is important, so it should be easy to create, maintain, and share. We’ve seen how Sphinx makes it easy to create, and how the autodoc extension, by pulling from docstrings, makes it easy to maintain. GitHub and ReadTheDocs make it easy to share. If we’re hosting our project on GitHub, as recommended in this course, then we can make our project’s documentation available on the web. Unfortunately, BitBucket does not currently support this feature. For open-source projects, ReadTheDocs will host our documentation for free, and it can be tied into GitHub to be kept up to date automatically.

Get hands-on with 1400+ tech skills courses.

Introduction

Basic Client Pages with React

Dynamic Client-Side Pages with React

Server-Side API Creation with Flask

Database Definition and Creation with SQLAlchemy

Code Documentation with Sphinx

An Introduction to Code Testing

UI Testing

API Testing

Database Integrity Testing

Automatically Testing Every Update

Design a Web Application

Build the Data Model

Build the REST API

Build the React Client

Finishing Touches for the App

Web Authentication

Deploy the Application

Conclusion

Appendix

Publish

Documentation