Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

middleware and patch docs are 404'ing #204

Open
jmhodges-color opened this issue Jan 15, 2022 · 3 comments
Open

middleware and patch docs are 404'ing #204

jmhodges-color opened this issue Jan 15, 2022 · 3 comments
Labels
type: bug Something isn't working type: documentation

Comments

@jmhodges-color
Copy link
Contributor

jmhodges-color commented Jan 15, 2022

When looking at the reference docs at https://honeycombio.github.io/beeline-python/ , the beeline.middleware and beeline.patch links in the Sub- modules section link to non-existent files.

This is unfortunate because I'm not sure how else to find pretty on-the-web docs for the django middleware and similar.

@jmhodges-color jmhodges-color added the type: bug Something isn't working label Jan 15, 2022
@robbkidd
Copy link
Member

🧐 Indeed, that a broken link. The docs publishing automation was removed a while back. Getting that working again will be a little persnickety. One workaround to have the docs locally would be to clone this repo, setup python and poetry, then:

> pip install pdoc
> pdoc beeline --output-directory ./docs

@jmhodges-color
Copy link
Contributor Author

Dope, thanks for being explicit with me!

@jmhodges-color
Copy link
Contributor Author

This is still busted, btw. Just tried linking some colleagues to them in some internal docs and couldn't!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug Something isn't working type: documentation
Projects
None yet
Development

No branches or pull requests

2 participants