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(docs): exclude docs/requirements.txt from docs build #12466

Merged

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Jan 4, 2024

Motivation

follow-up to #12360

Modifications

  • add /requirements.txt to exclude_docs in mkdocs.yml

Verification

  1. Run make docs
  2. Attempt to open site/requirements.txt which no longer works (it did prior to this change)

- it's currently being hosted on https://argo-workflows.readthedocs.io/en/latest/requirements.txt
  - this is a new file that we have to exclude now

- specify `/` in front which means only the ones in the `docs/` directory
  - see https://www.mkdocs.org/user-guide/configuration/#exclude_docs
    - notably, the in-line comments that the docs have don't actually work, it seems to cause the whole `exclude_docs` block to be ignored as a result

follow-up to e921056

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 requested a review from jmeridth January 4, 2024 22:15
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/build Build or GithubAction/CI issues labels Jan 4, 2024
@terrytangyuan terrytangyuan merged commit 96f25af into argoproj:main Jan 5, 2024
15 checks passed
@agilgur5 agilgur5 deleted the fix-docs-exclude-requirements-txt branch January 5, 2024 15:17
jmeridth added a commit to jmeridth/argo-workflows that referenced this pull request Jan 5, 2024
Includes fixes from argoproj#12464, argoproj#12466, argoproj#12465 - all authored by @agilgur5

Includes files list from argoproj#12414 description

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Anton Gilgur <agilgur5@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this pull request Jan 5, 2024
Includes fixes from argoproj#12464, argoproj#12466, argoproj#12465 - all authored by @agilgur5

Includes files list from argoproj#12414 description

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Anton Gilgur <agilgur5@gmail.com>
jmeridth added a commit to jmeridth/argo-workflows that referenced this pull request Jan 5, 2024
Includes fixes from argoproj#12464, argoproj#12466, argoproj#12465 - all authored by @agilgur5

Includes files list from argoproj#12414 description

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Anton Gilgur <agilgur5@gmail.com>
isubasinghe pushed a commit to isubasinghe/argo-workflows that referenced this pull request Feb 27, 2024
…12466)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
isubasinghe pushed a commit to isubasinghe/argo-workflows that referenced this pull request Feb 27, 2024
…12466)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
isubasinghe pushed a commit to isubasinghe/argo-workflows that referenced this pull request Feb 27, 2024
…12466)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
isubasinghe pushed a commit to isubasinghe/argo-workflows that referenced this pull request Feb 28, 2024
…12466)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Signed-off-by: Isitha Subasinghe <isubasinghe@student.unimelb.edu.au>
isubasinghe pushed a commit to isubasinghe/argo-workflows that referenced this pull request Mar 12, 2024
…12466)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added this to the v3.5.x patches milestone Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Build or GithubAction/CI issues area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants