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 a couple of documentation issues #2308

Merged
merged 3 commits into from
May 10, 2021
Merged

Fix a couple of documentation issues #2308

merged 3 commits into from
May 10, 2021

Conversation

ZedThree
Copy link
Member

@ZedThree ZedThree commented May 7, 2021

  • Typo in the CMake messages for building the docs
  • Latest version of breathe added a new option for the auto-doc tool that we call in a slightly weird way

@ZedThree
Copy link
Member Author

Using my admin privileges to merge this so that the readthedocs checks pass, otherwise other PRs have check failures that aren't relevant. Shout at me later if this turns out to cause problems 🙂

@ZedThree ZedThree merged commit 586c10c into next May 10, 2021
@ZedThree ZedThree deleted the fix-sphinx-docs branch May 10, 2021 13:13
@dschwoerer
Copy link
Contributor

I wanted to ask whether the targets should be renamed from sphinx- to manual- to match the autotools version and make it easier to find them? Or would make doc(s)- be even easier to guess?

More general, do we need to discover sphinx at configure time? I think it is nice to only check for sphinx as the user tries to build the docs?

@ZedThree
Copy link
Member Author

I wanted to ask whether the targets should be renamed from sphinx- to manual- to match the autotools version and make it easier to find them? Or would make doc(s)- be even easier to guess?

Yeah that's a fair-point. I was translating manual/Makefile which uses the sphinx- names, but the top-level Makefile calls them manual-. So it would be better to use that instead. docs is also a good name.

More general, do we need to discover sphinx at configure time? I think it is nice to only check for sphinx as the user tries to build the docs?

Currently, CMake tries to find them if you configure with BOUT_BUILD_DOCS, which is default off, so turning it indicates the user probably wants to build the docs. More practically, it's just much easier with CMake to find things at configure time.

@ZedThree
Copy link
Member Author

Now that I've merged this, RTD is pulling in Sphinx 4.0 which removes app.add_stylesheet, so there's a fix for that incoming shortly. I'll also add a target docs that builds sphinx-html

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

Successfully merging this pull request may close these issues.

None yet

2 participants