Skip to content

Conversation

@gpauloski
Copy link
Collaborator

Description

This PR makes a lot of changes to the documentation with the overall goal of making them more understandable and updated with the current ProxyStore code.

  • Fix typos
  • Update package links for PyPI in pyproject.toml
  • Update the copyright on the docs.
  • Open external links in new tabs.
  • Reference the extensions package.
  • Add links to source files in the API docs.
  • Open admonitions by default in APIs.
  • Improve CSS of docstrings.
  • Enabled inventory on the proxystore API so external packages can reference.
  • Big refresh on the documentation contents:
    • Adjusted page locations
    • Added "Concepts"
    • Expanded installation instructions.

Fixes

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (internal implementation changes)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (no changes to the code)
  • CI change (changes to CI workflows, packages, templates, etc.)
  • Version changes (changes to the package or dependency versions)

Testing

Inspected docs locally.

Pull Request Checklist

Please confirm the PR meets the following requirements.

  • Tags added to PR (e.g., breaking, bug, dependencies, documentation, enhancement, refactor).
  • Code changes pass pre-commit (e.g., black, mypy, ruff, etc.).
  • Tests have been added to show the fix is effective or that the new feature works.
  • New and existing unit tests pass locally with the changes.
  • Docs have been updated and reviewed if relevant.

@gpauloski gpauloski added the documentation Improvements or additions to documentation or examples label Mar 2, 2023
@gpauloski gpauloski merged commit 2a5adab into main Mar 2, 2023
@gpauloski gpauloski deleted the issue-199 branch March 2, 2023 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation or examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation Improvements

2 participants