Implement automated documentation with 100% API coverage and GitHub Pages deployment

[Copilot]

Replaced manual ReadTheDocs setup with automated Sphinx documentation deployed via GitHub Pages. All 149+ built-in functions and public APIs now auto-documented from source.

Changes

Documentation Structure

• Removed 18 obsolete planning documents (PHASE_, REFACTORING_)
• Created feature documentation with complete built-in function catalog (features.md)
• Added API overview organized by functionality (api.md)
• Auto-generated reference via sphinx-apidoc (reference.md)

Sphinx Configuration (docs/conf.py)

• Enabled autodoc extensions: autosummary, viewcode, intersphinx, napoleon
• Configured comprehensive coverage: all members, undocumented members, inheritance trees
• Automatic regeneration of API docs on every build

GitHub Actions Workflow (.github/workflows/docs.yml)

• Builds documentation on changes to src/**, docs/**, pyproject.toml
• Deploys to GitHub Pages on main/master pushes
• Python 3.12 build environment

Project Configuration

• Updated documentation URL to https://jango-blockchained.github.io/PyneScript/
• Removed .readthedocs.yml
• Added .nojekyll for GitHub Pages

Coverage

All project features documented:

• Core API (parse, unparse, dump, literal_eval)
• 149+ built-in functions across 15 categories (technical analysis, arrays, matrices, strings, math, strategy, plotting, drawing)
• AST components (builder, transformer, unparser, evaluator)
• Extensions (Pygments lexer, Nautilus Trader)
• CLI commands via sphinx-click

Documentation regenerates automatically on code changes to maintain 100% coverage.

Original prompt

Check the project docs. we need 100% coverage of all project features. the docs should be autogenerated on code changes. we should use github pages for docs. if needed you can remove the old docs and start from scratch

Created from VS Code via the GitHub Pull Request extension.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[jango-blockchained]

@copilot pynescriot is a private repo. if i merg the pr does the docs get accessable via github in public?

[Copilot]

@copilot pynescriot is a private repo. if i merg the pr does the docs get accessable via github in public?

GitHub Pages for private repositories behaves differently depending on your GitHub plan:

For GitHub Free/Pro: GitHub Pages sites from private repos are automatically public and accessible to anyone with the URL, even though the repository itself is private.

For GitHub Enterprise Cloud: You can keep the Pages site private and control access.

Since this appears to be a standard GitHub account, the documentation at https://jango-blockchained.github.io/PyneScript/ will be publicly accessible after merging, even though the repository is private.

Options if you want to keep docs private:

1. Don't enable GitHub Pages - keep using ReadTheDocs with private repo access
2. Upgrade to GitHub Enterprise Cloud for private Pages
3. Use repository permissions to restrict who can trigger the workflow (but the site itself will still be public once deployed)
4. Host documentation elsewhere with authentication (e.g., private ReadTheDocs, self-hosted Sphinx)

Would you like me to revert these changes and keep the ReadTheDocs configuration instead?

[Copilot]

Pull request overview

This pull request replaces the manual ReadTheDocs documentation setup with an automated Sphinx-based system deployed via GitHub Pages. The PR removes 18 obsolete planning documents and creates comprehensive feature documentation covering all 149+ built-in functions and public APIs.

Changes:

• Removed 18 obsolete planning/phase documents (PHASE_, REFACTORING_, PROGRESS_REPORT.md)
• Created comprehensive documentation structure (features.md, api.md, enhanced reference.md, README.md, DOCUMENTATION_COVERAGE.md)
• Configured Sphinx with autodoc extensions for automatic API documentation
• Set up GitHub Actions workflow for automatic documentation deployment
• Updated project URLs and badges to point to GitHub Pages

Reviewed changes

Copilot reviewed 29 out of 30 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
docs/features.md	New comprehensive feature catalog with 149+ built-in functions organized by category
docs/api.md	New API overview organized by functionality with autodoc directives
docs/reference.md	Enhanced auto-generated reference with navigation structure
docs/conf.py	Sphinx configuration with autodoc, autosummary, napoleon, viewcode, intersphinx
docs/README.md	New documentation development guide
docs/DOCUMENTATION_COVERAGE.md	New comprehensive coverage report
.github/workflows/docs.yml	GitHub Actions workflow for building and deploying to Pages
pyproject.toml	Updated documentation URL to GitHub Pages
README.md	Updated documentation links and badges
.readthedocs.yml	Removed ReadTheDocs configuration
docs/.nojekyll	Added for GitHub Pages compatibility
Multiple PHASE_/REFACTORING_	Removed 18 obsolete planning documents