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

Docs: https://pdoc.dev/ link to Google usage example is outdated #759

Closed
elliot-100 opened this issue Nov 18, 2024 · 4 comments
Closed

Docs: https://pdoc.dev/ link to Google usage example is outdated #759

elliot-100 opened this issue Nov 18, 2024 · 4 comments
Labels

Comments

@elliot-100
Copy link
Contributor

elliot-100 commented Nov 18, 2024

Problem Description

https://google.github.io/or-tools/ gives 404; appears to have moved to https://or-tools.github.io/docs/pdoc/ortools.html

Steps to reproduce the behavior:

  1. Go to https://pdoc.dev/
  2. Click Google logo near foot of page

(It looks like the Apache one may also be outdated, as clicking around I could only find https://pulsar.apache.org/api/python/3.5.x/ and https://pulsar.apache.org/api/python/3.0.x/ which seem to use pydoctor?)

System Information

Not applicable, docs only

@elliot-100 elliot-100 added the bug label Nov 18, 2024
@elliot-100
Copy link
Contributor Author

elliot-100 commented Nov 18, 2024

PS: I did try to submit a PR, but after installing OK as per CONTRIBUTING.md, and amending docs/index.html.jinja2, I ran make.py as per docs/README.md with no errors, but it did not seem to build index.html.

@mhils
Copy link
Member

mhils commented Nov 18, 2024

Please do send a PR, CI will take of building. :)

@elliot-100
Copy link
Contributor Author

Thanks - raised #760.

(After updating a few packages in my environment, I did eventually get output which implied I had been hitting memory issues when building the search index.)

@mhils
Copy link
Member

mhils commented Nov 19, 2024

Thanks again!

@mhils mhils closed this as completed Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants