Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Add HTTPS doc to table of contents, fix warning #681

Merged
merged 1 commit into from
May 5, 2022

Conversation

AetherUnbound
Copy link
Contributor

Description

This PR fixes an issue I noticed in #678 where the https.md guide was not showing in the table of contents. It also corrects a warning that had shown up in the sphinx output:

building [html]: targets for 2 source files that are out of date
updating environment: 0 added, 2 changed, 0 removed
reading sources... [100%] guides/publish                                                                                                                                                                            
looking for now-outdated files... none found
pickling environment... done
checking consistency... /api/docs/guides/https.md: WARNING: document isn't included in any toctree     <-- here
done
preparing documents... done
writing output... [100%] index                                                                                                                                                                                      
/api/docs/guides/publish.md:3: WARNING: 'myst' reference target not found: ghcr.io     <-- and here
generating indices... genindex py-modindex done
writing additional pages... search done
copying images... [100%] _static/publish_action_example.png                                                                                                                                                         
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 2 warnings.

The HTML pages are in build/html.

Screenshots

Before
Screenshot_2022-05-04_16-03-41

After
Screenshot_2022-05-04_16-04-42

Testing Instructions

  1. (Optionally) Check out main, run just sphinx-make && just sphinx-serve, visit http://0.0.0.0:3001/guides/index.html and observe that Testing HTTPS does not show up.
  2. On this branch, run just sphinx-make && just sphinx-serve, visit http://0.0.0.0:3001/guides/index.html and observe that Testing HTTPS does show up.
  3. Also, observe that the two above warnings no longer appear when running just sphinx-make.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@AetherUnbound AetherUnbound added 🟩 priority: low Low priority and doesn't need to be rushed 🛠 goal: fix Bug fix 📄 aspect: text Concerns the textual material in the repository labels May 4, 2022
@AetherUnbound AetherUnbound requested a review from a team as a code owner May 4, 2022 23:08
@AetherUnbound AetherUnbound requested review from krysal and dhruvkb May 4, 2022 23:08
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

👍

@AetherUnbound AetherUnbound merged commit 04d6c02 into main May 5, 2022
@AetherUnbound AetherUnbound deleted the bugfix/https-docs branch May 5, 2022 16:59
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants