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

Remove LaTeX documentation from readthedocs #1346

Merged
merged 1 commit into from
Oct 15, 2024

Conversation

climbfuji
Copy link
Collaborator

@climbfuji climbfuji commented Oct 14, 2024

Summary

Remove LaTeX documentation from the readthedocs configuration and fix two formatting errors in doc/source/NewSiteConfigs.rst. There are four warnings when I build the documentation manually, but no errors anymore. I checked the rendered HTML documentation, and the output looks ok (not sure what the warnings are about).

Testing

See readthedocs build below (https://spack-stack--1346.org.readthedocs.build/en/1346/NewSiteConfigs.html)

Applications affected

none

Systems affected

none

Dependencies

none

Issue(s) addressed

Resolves #1069

Checklist

  • This PR addresses one issue/problem/enhancement, or has a very good reason for not doing so.
  • These changes have been tested on the affected systems and applications.
  • All dependency PRs/issues have been resolved and this PR can be merged.

@climbfuji climbfuji marked this pull request as ready for review October 14, 2024 22:23
@climbfuji climbfuji self-assigned this Oct 14, 2024
@climbfuji climbfuji added the documentation Improvements or additions to documentation label Oct 14, 2024
@@ -1,15 +1,9 @@
cmake_minimum_required(VERSION 3.18 FATAL_ERROR)

project(spack-stack VERSION 1.3.1)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a way to get the version automatically? If we don't set the next version anywhere else then nevermind.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We do, in doc/src/conf.py we can use dev and develop for the short and long version in between releases, and then I set them on the release branch. CMakeLists.txt unfortunately doesn't allow that, only real versions.

Would be nice if we could set the version in one place and then inherit it from there. But probably a heavy lift, given that it's only three places.

Copy link
Collaborator

@AlexanderRichert-NOAA AlexanderRichert-NOAA left a comment

Choose a reason for hiding this comment

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

:)

@climbfuji climbfuji merged commit 7db4517 into JCSDA:develop Oct 15, 2024
8 checks passed
@climbfuji climbfuji deleted the feature/no_more_latex_docs branch October 15, 2024 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

Turn off LaTeX doc generation in sphinx/readthedocs
2 participants