Skip to content

Publish PharmaPy-org documentation and refresh developer attribution #130

Description

@bernalde

Context

The existing PharmaPy documentation at https://pharmapy.readthedocs.io/en/latest/ is still built from CryPTSys/PharmaPy and shows a 2023 revision. The repository now lives at PharmaPy-org/PharmaPy, but its current Read the Docs configuration installs only the runtime requirements; the Sphinx dependencies that used to be present are no longer installed. Some repository metadata also still points to SECQUOIA.

This issue tracks both the repository changes needed for a reproducible documentation build and the external Read the Docs connection needed to publish it.

Attribution

Preserve the original PharmaPy author/developer credits and distinguish them from the current development team. As of July 2026, the current team to credit is:

The documentation should also identify PharmaPy as a joint project involving CryPTSys, SECQUOIA, Can Li, and Eli Lilly and Company.

Acceptance criteria

Repository work

  • Define a dedicated, installable set of documentation dependencies.
  • Configure .readthedocs.yaml to install PharmaPy with those documentation dependencies.
  • Add CI that builds the complete Sphinx site in warning-as-error mode from a fresh environment.
  • Preserve the original authorship credits while adding a clearly labeled current-developers section and partner acknowledgements.
  • Update package maintainers and repository URLs to PharmaPy-org/PharmaPy.
  • Update stale SECQUOIA repository references in the README badge.
  • Do not commit generated HTML.

Read the Docs administration

  • Preferred: an administrator of the existing Read the Docs project reconnects it to PharmaPy-org/PharmaPy and installs/authorizes the Read the Docs GitHub App for the new organization.
  • If control of the existing project cannot be obtained, import the new repository as a new Read the Docs project and choose a stable project slug.
  • Confirm pushes to master trigger builds and pull requests receive build status/preview checks.
  • Confirm the live site is built from the current PharmaPy-org/PharmaPy revision and its source/edit links point to the new repository.
  • Once the live destination is confirmed, update any documentation URL/badge whose destination changed.

Scope note

The repository-side pull request should reference this issue but not close it. The issue can close only after the external Read the Docs connection and live-site verification are complete.

Read the Docs integration guide: https://docs.readthedocs.com/platform/latest/guides/connecting-git-account.html

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:ciGitHub Actions and continuous integrationarea:docsDocumentation, typing docs, and API docsdocumentationImprovements or additions to documentationstatus:plannedPlanned roadmap or maintenance work, not a verified bug report

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions