Skip to main content
Ctrl+K

python-programming 0.1.0 documentation

  • Getting Started
  • extract_source_code Module
  • file_ops Module
  • generate_rst Module
  • logger_setup Module
    • tasks Module
    • Tutorials Test
    • conf Module
    • Concepts Test
  • Getting Started
  • extract_source_code Module
  • file_ops Module
  • generate_rst Module
  • logger_setup Module
  • tasks Module
  • Tutorials Test
  • conf Module
  • Concepts Test

python-programming documentation#

Add your content using Google syntax for the napoleon extension. See the Google documentation for details.

Table of Contents#

  • Sphinx Guide

  • Utilities

  • API

  • Tutorials

  • Reference

  • Concepts

  • Reports

Sphinx Guide#

  • Getting Started
    • Table of Contents
    • Prerequisites
    • Installation
    • Configuring Sphinx
    • Documenting Your Code
    • Adding Documentation Files (.rst)
    • Building the Documentation
    • Iterating and Updating

Utilities#

  • extract_source_code Module
    • clean_directory()
    • clear_jupyter_outputs()
    • contains_template_html()
    • should_delete_dir()
  • file_ops Module
    • MissingEnvironmentVariable
    • create_directories()
    • get_env_variable()
    • get_git_repo_name()
    • get_git_root()
    • load_env_once()
    • zip_files_with_password()
  • generate_rst Module
    • find_modules()
    • generate_module_rst()
    • run_generator()
  • logger_setup Module
    • setup_universal_logging()

API#

  • tasks Module

Tutorials#

  • Tutorials Test

Reference#

  • conf Module
    • add_all_subdirectories_to_path()
    • clear_destination()
    • copy_notebooks()
    • import_notebooks()
    • is_included_notebook()
    • main()
    • should_skip_directory()

Concepts#

  • Concepts Test

Reports#

next

Documentation Setup Guide

On this page
  • Table of Contents
  • Sphinx Guide
  • Utilities
  • API
  • Tutorials
  • Reference
  • Concepts
  • Reports

This Page

  • Show Source

© Copyright 2026, Michael Evans.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.16.1.