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 environment page in docs #2257

Merged
merged 3 commits into from
Jan 3, 2024
Merged

Fix environment page in docs #2257

merged 3 commits into from
Jan 3, 2024

Conversation

ammar92
Copy link
Contributor

@ammar92 ammar92 commented Jan 2, 2024

Changes

This PR fixes the environment section in the docs. The Makefile has been slightly modified for cross platform usage and the template file has been updated to use the new setting-docs.

Issue link

Closes #1815

Demo

image

Code Checklist

  • All the commits in this PR are properly PGP-signed and verified;
  • This PR only contains functionality relevant to the issue; tickets have been created for newly discovered issues.
  • I have written unit tests for the changes or fixes I made.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have performed a self-review of my code and refactored it to the best of my abilities.

Communication

  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have made corresponding changes to the documentation, if necessary.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@ammar92 ammar92 linked an issue Jan 2, 2024 that may be closed by this pull request
@Donnype
Copy link
Contributor

Donnype commented Jan 3, 2024

Works as expected locally 👍

@ammar92 ammar92 marked this pull request as ready for review January 3, 2024 09:15
@ammar92 ammar92 requested a review from a team as a code owner January 3, 2024 09:15
@underdarknl underdarknl merged commit 3fde22b into main Jan 3, 2024
7 checks passed
@underdarknl underdarknl deleted the fix/environment-docs branch January 3, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Mula environment docs are broken due to Pydantic v2 upgrade
3 participants