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

allow running doctests with Revise #38258

Merged
merged 1 commit into from
Jan 14, 2021
Merged

allow running doctests with Revise #38258

merged 1 commit into from
Jan 14, 2021

Conversation

simeonschaub
Copy link
Member

I think it would be quite useful to be able to run doctests using Revise as well. This worked for me locally, but please let me know if this should be implemented in a different way. Right now, I am creating a new environment in doc/deps/revise, in which Revise is installed and then I push that onto LOAD_PATH, but there might be a nicer way to do this.

@simeonschaub simeonschaub added docsystem The documentation building system test This change adds or pertains to unit tests labels Nov 2, 2020
@staticfloat
Copy link
Member

I don't think I'm the right person to review this. Maybe @fredrikekre? :)

@simeonschaub simeonschaub removed the request for review from staticfloat November 2, 2020 19:17
@StefanKarpinski
Copy link
Member

@Keno might be a good person to review since he added the revise-test functionality.

@simeonschaub
Copy link
Member Author

Just bumping this again. Not really urgent, but I think this would be nice to have.

Copy link
Member

@timholy timholy left a comment

Choose a reason for hiding this comment

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

I like it!

Maybe it's just me, but I use "draft" to mean "something I am working on that isn't ready for review yet". So I never review anything marked "draft" unless specifically requested.

doc/make.jl Show resolved Hide resolved
@simeonschaub simeonschaub marked this pull request as ready for review January 3, 2021 10:03
Copy link
Member

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

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

This seems suuuuper helpful. I must confessed that I've given up on more than one doc change PR for Julia because the "modify - rebuild Julia - fix mistake - rebuild Julia - ... " cycle is sooo painful (I was trying to add more crossrefs and examples, and just figuring out how to get the crossrefs working drove me crazy and I gave up).

I can only speak for myself, but I think this PR would substantially boost my motivation to contribute tweaks to the Julia documentation, and hopefully it would do so for others, too.

doc/Makefile Outdated Show resolved Hide resolved
@simeonschaub
Copy link
Member Author

I just started looking into this again, but doesn't seem like this works for Base yet and it also automatically rebuilds Julia every time changes are made to Base, so marking this as a draft again until I figure this out.

@simeonschaub simeonschaub marked this pull request as draft January 11, 2021 21:03
@simeonschaub simeonschaub marked this pull request as ready for review January 11, 2021 22:23
@simeonschaub simeonschaub changed the title RFC: allow running doctests with Revise allow running doctests with Revise Jan 11, 2021
@simeonschaub
Copy link
Member Author

Ok, I now tested this locally for Base and LinearAlgebra and everything seemed to work as expected.

@simeonschaub simeonschaub requested a review from timholy January 11, 2021 22:25
@simeonschaub simeonschaub merged commit 006f90d into master Jan 14, 2021
@simeonschaub simeonschaub deleted the sds/revise_doctests branch January 14, 2021 08:40
ElOceanografo pushed a commit to ElOceanografo/julia that referenced this pull request May 4, 2021
antoine-levitt pushed a commit to antoine-levitt/julia that referenced this pull request May 9, 2021
timholy added a commit that referenced this pull request Aug 27, 2021
timholy added a commit that referenced this pull request Aug 27, 2021
LilithHafner pushed a commit to LilithHafner/julia that referenced this pull request Feb 22, 2022
LilithHafner pushed a commit to LilithHafner/julia that referenced this pull request Mar 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsystem The documentation building system test This change adds or pertains to unit tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants