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.

Sign up for GitHub

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

Jump to bottom

Fix the build by bumping to crate-docs 1.0.0 #246

Merged
merged 2 commits into from Mar 18, 2021
Merged

Fix the build by bumping to crate-docs 1.0.0 #246

merged 2 commits into from Mar 18, 2021

Conversation

amotl
Copy link
Member

@amotl amotl commented Mar 18, 2021 •
edited

Hi there,

this patch fixes crate/crate-docs#65 reported by @msbt. You can either choose this one, or bring in #245 instead. Or do both, one after the other.

With kind regards,
Andreas.

@amotl amotl requested review from nomicode, msbt and a team March 18, 2021 12:16
@amotl
Fix the build by bumping to crate-docs 1.0.0
98058fb
@amotl
Satisfy the linkchecker by using an alternative anchor
a7b87ad 
I actually don't know why "#make-changes" isn't working anymore. The
browser still honors and evaluates this anchor perfectly. We will
probably have to file an issue with Sphinx on this.
@nomicode
Copy link
Contributor

@amotl can you bring in my changes to docs/Makefile (https://github.com/crate/crate-docs-theme/pull/245/files). this is required for a proper upgrade. see the release notes: https://github.com/crate/crate-docs/releases/tag/1.0.0

I'm happy to then merge this pr and drop the related commit from #245

@nomicode
Copy link
Contributor

side note: I am not clear on how this fixes crate/crate-docs#65. or rather, I am not clear on what causes crate/crate-docs#65. can you elaborate?

@amotl amotl mentioned this pull request Mar 18, 2021
Merged
@amotl
Copy link
Member Author

amotl commented Mar 18, 2021 •
edited

I am not clear on how this fixes crate/crate-docs#65. or rather, I am not clear on what causes crate/crate-docs#65. can you elaborate?

I believe the reason is that crate-docs 0.4.0 explicitly tests for python3.7? However, I don't know exactly. I have been able to reproduce it on my machine and bumping to crate-docs 1.0.0 mitigated the problem. So, let's just go ahead, right?

@amotl amotl mentioned this pull request Mar 18, 2021
Merged
nomicode
nomicode approved these changes Mar 18, 2021
View reviewed changes
Copy link
Contributor

@nomicode nomicode left a comment

Choose a reason for hiding this comment

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

I think it's a bit unconventional to do the Makefile change in a separate pr (#247) but the end result will be the same so I don't mind. let's go ahead

@amotl amotl merged commit 094c148 into master Mar 18, 2021
@amotl amotl deleted the amo/fix-build branch March 18, 2021 12:40
amotl
amotl commented Mar 18, 2021
View reviewed changes
docs/index.rst
.. _developer guide: https://github.com/crate/crate-docs-theme/blob/master/DEVELOP.rst#make-changes
.. _developer guide: https://github.com/crate/crate-docs-theme/blob/master/DEVELOP.rst#user-content-make-changes
Copy link
Member Author

Choose a reason for hiding this comment

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

Attaching to this, I just created sphinx-doc/sphinx#9016.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nomicode nomicode nomicode approved these changes

@msbt msbt Awaiting requested review from msbt

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Build doesn't work anymore
2 participants
@amotl @nomicode