Documentation online

[tschm]

In this pull request I introduce a ci/cd job that constructs (based on pdoc) a webpage containing a first documentation for this project. You may have to modify your settings and publish pages from a Github Action. I can help if you can't see the page. I have activated this for my fork, see https://tschm.github.io/quantstats_lumi/quantstats_lumi.html

Description by Korbit AI

What change is being made?

Add a GitHub Actions workflow to automatically generate and publish API documentation for the quantstats_lumi package using pdoc, and update the README with instructions for accessing the documentation.

Why are these changes being made?

The changes automate the generation and deployment of API documentation to ensure that it is consistently updated with the latest code changes, enhancing accessibility and reference for users. This reduces manual documentation efforts and provides a reliable, comprehensive resource for developers interacting with the package.

Is this description stale? Ask me to generate a new description by commenting /korbit-generate-pr-description

[korbit-ai]

I've completed my review and didn't find any issues.

Check out our docs on how you can make Korbit work best for you and your team.

Loving Korbit!? Share us on LinkedIn Reddit and X

[cursor]

Bug: Unnecessary Deployments and Fork Issues

The DOCUMENTATION workflow deploys to GitHub Pages on every push to any branch, leading to unnecessary deployments and potential overwriting of production documentation. Furthermore, the commented-out if: ${{ !github.event.repository.fork }} condition causes the deployment step to run on forks, which will likely fail due to permission issues or GitHub Pages not being enabled.

.github/workflows/pdoc.yml#L57-L60

quantstats_lumi/.github/workflows/pdoc.yml

Lines 57 to 60 in 8ffac58

	# This step publishes the content to GitHub Pages
	- name: Deploy to GitHub Pages
	#if: ${{ !github.event.repository.fork }}
	uses: actions/deploy-pages@v4 # Official GitHub Pages deployment action

Fix in Cursor • Fix in Web

---

Was this report helpful? Give feedback by reacting with 👍 or 👎

[tschm]

Yes, you may want to publish only from main or only triggered with a release etc.