Skip to content

Conversation

@camUrban
Copy link
Owner

@camUrban camUrban commented Nov 22, 2025

Introduces a full documentation site for PteraSoftware using Sphinx, including configuration files, custom templates, static assets, and example content. Adds .readthedocs.yaml for Read the Docs integration and updates IDE settings for a dedicated docs virtual environment.

Description

Adds documentation hosted by Read the Docs.

Motivation

Hopefully this will make getting started with Ptera Software more accessible.

Relevant Issues

Closes #57

Changes

  • Added new dependencies to docs\requirements_docs.txt
  • Added directories docs\_static, docs\_templates, docs\favicons, and docs\internals for storing assets for the documentation website
  • Added files .readthedocs.yaml, docs\api.md, docs\conf.py, docs\examples.md, docs\index.md, docs\install.md docs\internals.md, and docs\quickstart.md to configure the website
  • Added the auto-generated documentation content in docs/_build/ to the .gitignore

New Dependencies

Development Dependencies

  • furo
  • myst-parser
  • sphinx
  • sphinx-autoapi
  • sphinx-copybutton

Change Magnitude

Minor: Small change such as a bug fix, small enhancement, or documentation update.


Checklist

  • I have created or claimed an issue for this work as described in Contributing Code.
  • My branch is based on main and is up to date with the upstream main branch.
  • All calculations use S.I. units.
  • Code is formatted with black (line length = 88).
  • Code is well documented with block comments where appropriate.
  • Any external code, algorithms, or equations used have been cited in comments or docstrings.
  • All new modules, classes, functions, and methods have docstrings in reStructuredText format, and are formatted using docformatter (--in-place --black).
  • All new classes, functions, and methods use type hints.
  • If any major functionality was added or significantly changed, I have added or updated tests in the tests package.
  • Code locally passes all tests in the tests package.
  • After pushing, PR passes all automated checks (codespell, black, mypy, and tests).
  • PR description links all relevant issues and follows this template.

@camUrban camUrban added maintenance Improvements or additions to documentation, testing, or robustness feature New feature or request help wanted Extra attention is needed good first issue Good for newcomers dependencies Pull requests that update a dependency file labels Nov 22, 2025
@camUrban camUrban self-assigned this Nov 22, 2025
@codecov
Copy link

codecov bot commented Nov 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.33%. Comparing base (6a10acd) to head (3efef8a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #58   +/-   ##
=======================================
  Coverage   87.33%   87.33%           
=======================================
  Files          28       28           
  Lines        4597     4597           
=======================================
  Hits         4015     4015           
  Misses        582      582           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@camUrban camUrban force-pushed the feature/read_the_docs branch from a82edcd to 0445cd7 Compare November 23, 2025 23:28
Introduces a full documentation site for PteraSoftware using Sphinx, including configuration files, custom templates, static assets, and example content. Adds .readthedocs.yaml for Read the Docs integration and updates IDE settings for a dedicated docs virtual environment.
@camUrban camUrban force-pushed the feature/read_the_docs branch from 9c37183 to 0a052ad Compare November 24, 2025 01:03
Introduces a full documentation site for PteraSoftware using Sphinx, including configuration files, custom templates, static assets, and example content. Adds .readthedocs.yaml for Read the Docs integration and updates IDE settings for a dedicated docs virtual environment.
@camUrban camUrban force-pushed the feature/read_the_docs branch from 0a052ad to fd56cc0 Compare December 5, 2025 04:27
@camUrban camUrban marked this pull request as ready for review December 11, 2025 16:30
Introduces a full documentation site for PteraSoftware using Sphinx, including configuration files, custom templates, static assets, and example content. Adds .readthedocs.yaml for Read the Docs integration and updates IDE settings for a dedicated docs virtual environment.
Introduces a full documentation site for PteraSoftware using Sphinx, including configuration files, custom templates, static assets, and example content. Adds .readthedocs.yaml for Read the Docs integration and updates IDE settings for a dedicated docs virtual environment.
@camUrban camUrban force-pushed the feature/read_the_docs branch from d09d112 to e11a1ca Compare December 14, 2025 22:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file feature New feature or request good first issue Good for newcomers help wanted Extra attention is needed maintenance Improvements or additions to documentation, testing, or robustness

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] Hosting Documentation with Read the Docs

2 participants