best practices for GitHub pages?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
GitHub pages are a common way to host documentation for sites. They require one of the following to host in source code:
- master branch /docs folder
- master branch
- gh-pages branch
Right now I'm using master branch /docs for pygdbmi, and I have what I would assume is a very common project structure, yet my workflow has a little hack in it. I generate my docs with the following make recipe:
docs:
pdoc --html --force --output-dir docs pygdbmi
mv docs/pygdbmi/* docs
rmdir docs/pygdbmi
Is there a way to generate docs directly to the --output-dir? By namespacing it with the package name, it breaks it for GitHub pages.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the documented make recipe and the pdoc --html invocation shown in the issue, then inspect how --output-dir handles the generated package directory. The work is done when documentation can be generated directly into a GitHub Pages-compatible source directory without the mv and rmdir steps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100