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 typos #228

Merged
merged 3 commits into from
Feb 19, 2025
Merged

✏️ Fix typos #228

merged 3 commits into from
Feb 19, 2025

Conversation

ebouchut
Copy link
Contributor

@ebouchut ebouchut commented Feb 17, 2025

This PR fixes a few typos on the following pages:

  • Setup Uploaders where the inline-code block should be bold whereas it is messed up

    CleanShot 2025-02-17 at 15 28 51@2x
    CleanShot 2025-02-17 at 15 28 37@2x

  • README.md where the folder containing generated HTML files should now be _build instead of _build/dirhtml, according to my understanding of Sphinx v5.3.0 output:
    cd nightscout.github.io
    sphinx-build -b dirhtml docs _build
    
      Running Sphinx v5.3.0
      loading pickled environment... done
      myst v1.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'html_admonition', 'html_image', 'colon_fence'}, disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=6, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
      building [mo]: targets for 0 po files that are out of date
      building [dirhtml]: targets for 0 source files that are out of date
      updating environment: 0 added, 0 changed, 0 removed
      looking for now-outdated files... none found
      no targets are out of date.
      build succeeded.
    
      The HTML pages are in _build.
    
    # cd ../nightscout.github.io/_build/dirhtml # <== ❌ Folder does not exist
    cd ../nightscout.github.io/_build           # <== ✅
    python -m http.server

Copy link
Contributor Author

@ebouchut ebouchut left a comment

Choose a reason for hiding this comment

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

👍 LGTM.

@psonnera
Copy link
Collaborator

@ebouchut took me some time and comments deletion before reaching the conclusion that sphinx-build -b dirhtml docs _build does create a subfolder dirhtml below _build hence the correct path nightscout.github.io/_build/dirhtml is where index.html lies.
Still, instead of jumping up and down, cd _build/dirhtml should do the trick.
And the typo is a good catch. 👍
image

@psonnera
Copy link
Collaborator

Right. Just wanted to approve the first commit, not the second one.

@ebouchut
Copy link
Contributor Author

Thank you Patrick for your quick feedback.

SphinxNewbie here> I noticed that with:

  • sphinx-build -b dirhtml docs _build
    the directory structure is not created

  • sphinx-build -M dirhtml docs _build
    the directory structure is created.

@psonnera
Copy link
Collaborator

@ebouchut they're pretty similar. I use -b and it does create the whole structure
https://www.sphinx-doc.org/en/master/usage/builders/index.html

@ebouchut
Copy link
Contributor Author

Right. Just wanted to approve the first commit, not the second one.

Ok, then I reverted the second commit (README update) from the PR.
If you prefer, I can remove the last 2 useless commits (update README + revert update).

ℹ️ However, in my case (maybe MacOS or local config related?), the command in the README does not create the HTML pages in _build/dirhtml but in _build!
See:
asciicast

@ebouchut
Copy link
Contributor Author

ebouchut commented Feb 18, 2025

I cannot figure out what is the root cause of the doc build issue.
The GitHub Actions used in the documentation.yaml CI workflow file are outdated.
If there is no particular reason to stick with older versions, I suggest upgrading them all to see if this fixes the problem, I have a commit ready for this.

@psonnera
Copy link
Collaborator

: asciicast
Second time it works though

@psonnera
Copy link
Collaborator

The GitHub Actions used in the documentation.yaml CI workflow file are outdated. If there is no particular reason to stick with older versions, I suggest upgrading them all to see if this fixes the problem, I have a commit ready for this.

Please submit your PR, I haven't looked at the actions for years. Thank you

@psonnera psonnera merged commit cd61404 into nightscout:source Feb 19, 2025
1 check failed
@ebouchut ebouchut deleted the fix/typo branch February 19, 2025 20:23
@ebouchut
Copy link
Contributor Author

🥳 Thanks.
It only works the second time with -M, but not when using -b (the first time).

I will open another PR with the GH actions upgraded.

@psonnera
Copy link
Collaborator

@ebouchut you know what? You're right. That's M not b

@ebouchut
Copy link
Contributor Author

The GitHub Actions used in the documentation.yaml CI workflow file are outdated. If there is no particular reason to stick with older versions, I suggest upgrading them all to see if this fixes the problem, I have a commit ready for this.

Please submit your PR, I haven't looked at the actions for years. Thank you

Here it is #230.
This PR:

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.

2 participants