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.

Sign up for GitHub

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

Jump to bottom

Integrating MkDocs #38

Merged
merged 10 commits into from
Aug 8, 2024
Merged

Integrating MkDocs #38

merged 10 commits into from
Aug 8, 2024

Conversation

MohamedNasser8
Copy link
Collaborator

Changes Made

  • Added MkDocs configuration file (mkdocs.yml) to project root.
  • Created docs directory for MkDocs documentation sources.

To run the MkDocs documentation locally, follow these steps:

  1. Navigate to the docs-mk Directory:

    cd docs-mk

  2. Start MkDocs Server:

    mkdocs serve

ltorres6
ltorres6 requested changes Aug 5, 2024
View reviewed changes
Copy link
Collaborator

@ltorres6 ltorres6 left a comment

Choose a reason for hiding this comment

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

LGTM but change the docs-mk folder to docs and remove the original "docs" folder with the deprecated sphinx work.

.github/workflows/documentation.yaml Outdated Show resolved Hide resolved
docs-mk/docs/about/index.md Outdated Show resolved Hide resolved
@ltorres6 ltorres6 changed the base branch from main to DCE_DRO August 5, 2024 14:50
@ltorres6 ltorres6 changed the base branch from DCE_DRO to main August 5, 2024 14:50
@MohamedNasser8
change docs-mk to docs
383310d
@MohamedNasser8
changed matplotlib version
5df19bc 
changed matplotlib version as the new version gives some errors in the workflow
@ltorres6 ltorres6 self-requested a review August 5, 2024 20:20
ltorres6
ltorres6 approved these changes Aug 8, 2024
View reviewed changes
Copy link
Collaborator

@ltorres6 ltorres6 left a comment

Choose a reason for hiding this comment

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

Good to merge

@ltorres6 ltorres6 merged commit e484096 into main Aug 8, 2024
5 checks passed
@ltorres6 ltorres6 deleted the docs branch August 8, 2024 14:58
@MohamedNasser8 MohamedNasser8 restored the docs branch August 8, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ltorres6 ltorres6 ltorres6 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@MohamedNasser8 @ltorres6