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

Fix documentation #251

Merged
merged 30 commits into from
Sep 9, 2021
Merged

Fix documentation #251

merged 30 commits into from
Sep 9, 2021

Conversation

bonjourmauko
Copy link
Member

@bonjourmauko bonjourmauko commented Aug 26, 2021

Fixes #243
Fixes #244
Depends on openfisca/openfisca-core#1038

Bug Fix

  • Adapt to latest changes in core to render the documentation

Demo:

Capture d’écran 2021-08-26 à 19 09 43

Copy link
Member

@MattiSG MattiSG left a comment

Choose a reason for hiding this comment

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

Looks good on my side.

@HAEKADI could you please confirm this fixes the documented problem? 🙂

@MattiSG MattiSG requested a review from HAEKADI September 1, 2021 13:42
Copy link
Contributor

@HAEKADI HAEKADI left a comment

Choose a reason for hiding this comment

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

Thank you @maukoquiroga! Great 👏

This does indeed fix the doc problem, however the Reforms doc is still not generated.

Screenshot 2021-09-01 at 16 24 23

@bonjourmauko
Copy link
Member Author

Thanks a lot for the review @HAEKADI ! In fact, I discovered that half of the doc was still missing 😄 , I've corrected it and it should normally work as expected now.

@HAEKADI
Copy link
Contributor

HAEKADI commented Sep 1, 2021

Yes it does :)
I guess the build will not work before merging the openfisca/openfisca-core#1038.
But otherwise everything seems to be in order 👍

@bonjourmauko
Copy link
Member Author

@HAEKADI exactly, the tricky part of the situation is that as the documentation is in a different repository, we're forced to stage changes somehow to avoid the chicken-egg problems. What I propose in openfisca/openfisca-core#1038 is the easiest way I could imagine to achieve that, without involving complex platform-dependent workflows, obscure git features, and so on. Please do not hesitate if you think of another way to solve the specific core → doc problem to tell me —I did of course thought about re-merging together core and the doc, which is the standard for many libraries, but I intend to propose it separately as it is a major change just for a bug fix IMHO.

@HAEKADI
Copy link
Contributor

HAEKADI commented Sep 6, 2021

@maukoquiroga I agree :) Looking at the changes, it might seem like it is redundant to have them in both repos core and doc. But as you said, as it is a significant task to merge the two, it is better to do it separately.

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

Successfully merging this pull request may close these issues.

Python API documentation seems broken Building the documentation raises an error and warnings
3 participants