aai-institute / aai-institute/kyle
Documentation build out of sync wrt pypi
- Dominant language
- Jupyter Notebook
- Stars
- 14
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Docs are built from develop => out of sync with releases. I think pages should only be built from master, after a release to pypi. Alternatively, one could maintain versions for all tags, allowing to switch between them, like in read the docs, but doing that manually would be a pita.
Contributor guide
No contributing guide indexed for this repository
Research direction
Look at the GitHub Pages configuration in the repository settings or the workflow files (like .github/workflows) to see how documentation is currently built. Check if there's a script or CI job that triggers on pushes to develop vs master. Understand the release process to pypi and how documentation updates should align with tagged releases. The goal is to adjust the build source from develop to master or implement a versioning strategy.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100