Skip to content

Sample application demonstrating documentation added to a Python project.

License

Notifications You must be signed in to change notification settings

sekyondaMeta/pydocsite

This branch is 7 commits behind brianjo/pydocsite:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5df78bd · Feb 24, 2023
Feb 14, 2022
May 4, 2020
May 4, 2020
Apr 19, 2022
May 4, 2020
Feb 1, 2023
Feb 24, 2023
Aug 3, 2021
May 4, 2020
May 4, 2020
May 4, 2020
Feb 5, 2021
May 4, 2020
May 4, 2020

Repository files navigation

Python Documentation Site Example

This example was developed to demonstrate how Docusaurus, Sphinx, and GitHub actions can be used to easily add a website landing to a project.

This project is based on Ken Reitz's excellent Python starting project: Learn more.

If you want to learn more about setup.py files, check out this repository.

We added Sphinx and Docusaurus 2 for documentation.

Testing this project

To test this project in your own repo, follow these steps:

  1. Fork this repo.
  2. Turn GitHub Pages on in Settings
  3. Enable the GitHub Actions workflow
  4. Customize your site in website
  5. Customize the API content in /sphinx and source

Changes should trigger a rebuild.

Your site should be available at https://<accountname>.github.io/pydocsite.

The GitHub action uses James Ives GitHub Deploy Action.

About

Sample application demonstrating documentation added to a Python project.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 47.9%
  • JavaScript 21.4%
  • Python 12.3%
  • Makefile 7.6%
  • Batchfile 6.9%
  • CSS 2.3%
  • Other 1.6%