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

sphinx does not properly link to adafruit_motor classes #25

Closed
ktdreyer opened this issue Jan 1, 2021 · 3 comments
Closed

sphinx does not properly link to adafruit_motor classes #25

ktdreyer opened this issue Jan 1, 2021 · 3 comments
Assignees

Comments

@ktdreyer
Copy link

ktdreyer commented Jan 1, 2021

Something is not quite right with the Sphinx links for adafruit_motor. The servokit API page has the strings :py:class:~adafruit_motor.servo.ContinuousServo and :py:class:~adafruit_motor.servo.Servo rather than linking to the class docs for ContinuousServo and Servo.

I was looking at this a bit, and I can't figure out how to make Sphinx link those classes, but maybe someone has some idea?

@ladyada
Copy link
Member

ladyada commented Jan 2, 2021

im not a sphinx-pert... @tannewt any advice (or someone else who knows the deets)?

@tannewt
Copy link
Member

tannewt commented Jan 5, 2021

I think there are two things to do:

  1. Use one ` instead of two where the references are. For example: https://github.com/adafruit/Adafruit_CircuitPython_ServoKit/blob/master/adafruit_servokit.py#L107 Once that's done, the doc build should break.
  2. Add the intersphinx mapping for motor to the conf.py here: https://github.com/adafruit/Adafruit_CircuitPython_ServoKit/blob/master/docs/conf.py#L33 It should follow the same pattern as Register. This should fix the doc build.

@ktdreyer Want to try fixing it?

@jposada202020
Copy link
Contributor

Fix by #28

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants