Giter Site home page Giter Site logo

jlrzarcor / example-python-package-and-sphinx-doc Goto Github PK

View Code? Open in Web Editor NEW

This project forked from palmoreck/example-python-package-and-sphinx-doc

0.0 1.0 0.0 253 KB

repo for showing small python package integration with Sphinx doc and publishing it with github pages

Jupyter Notebook 31.41% Python 53.19% Makefile 6.83% Batchfile 8.57%

example-python-package-and-sphinx-doc's Introduction

Example of sphinx documentation for Python3 package and publishing it with github-pages

  1. Fork this repo.

  2. Make sure Github Pages is enabled in your repo settings.

  3. In this README.md change the url that has this next link: online doc to point to your site of Github Pages.

  4. Modify some .rst doc for example src/docs/index.rst to trigger gh action for building doc.

  5. Go to online doc of step 3 after github actions succeed building doc.

Note: if you want to create a package in src with different functions for example, then make the proper substitutions in src and change the .rst files related with correspondent files in docs to trigger gh action for building doc.

example-python-package-and-sphinx-doc's People

Contributors

jlrzarcor avatar palmoreck avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.