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

Use viewcode sphinx extension #1443

Merged
merged 1 commit into from
Dec 16, 2020
Merged

Use viewcode sphinx extension #1443

merged 1 commit into from
Dec 16, 2020

Conversation

rahulporuri
Copy link
Contributor

Using this extension means that API docs now link to source code. See example below which now includes the source button.

sphinx-viewcode

Using this extension means that API docs now link to source code

	modified:   docs/source/conf.py
Copy link
Contributor

@aaronayres35 aaronayres35 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I built the docs and it seems to be working.

However, it does not seem to show up as an option for everything?
e.g.
Screen Shot 2020-12-15 at 9 11 46 AM
Screen Shot 2020-12-15 at 9 13 07 AM

Not sure what the cause of this is / if it is expected

@rahulporuri
Copy link
Contributor Author

@aaronayres35 something looks off. can you clean and rebuild? I am not seeing the issue.

somethingisoff

@aaronayres35
Copy link
Contributor

aaronayres35 commented Dec 15, 2020

@aaronayres35 something looks off. can you clean and rebuild? I am not seeing the issue.

Just tried, but I'm still seeing what I saw before ... :/
Not sure what's going on

@kitchoi
Copy link
Contributor

kitchoi commented Dec 15, 2020

Built locally and picked a handful of modules, I can see the link to the source for traitsui.editor_factory.EditorFactory (and I can see the rendered source).

@rahulporuri rahulporuri merged commit b274358 into master Dec 16, 2020
@rahulporuri rahulporuri deleted the doc/viewcode-ext branch December 16, 2020 09:39
@rahulporuri rahulporuri moved this from In Progress to Done in Enthought OSS Q4 2020 Dec 16, 2020
@rahulporuri rahulporuri moved this from Done to Sprint 6 : Dec 14 2020 - Jan 2 2021 in Enthought OSS Q4 2020 Jan 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Enthought OSS Q4 2020
Sprint 6 : Dec 14 2020 - Jan 2 2021
Development

Successfully merging this pull request may close these issues.

None yet

3 participants