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

Documentation to MKDocs #1450

Closed
wants to merge 7 commits into from
Closed

Documentation to MKDocs #1450

wants to merge 7 commits into from

Conversation

vcaldas
Copy link
Contributor

@vcaldas vcaldas commented Nov 6, 2024 •
edited
Loading

This PR initializes the documentation migration to MKDocs.
Related to #1434

This includes:

  • CI/CD Pipeline to deploy the website - triggered when merged to 'develop' or 'master'
  • Necessary changes to the current folder references to be compliant with mkdocs
  • Search bar
  • Color selection based on the user choice

After this PR, the admin has to:

  • enable page publication that takes 'gh-pages' branch as the source

Documentation will be available at: https://robcarver17.github.io/pysystemtrade/

@bug-or-feature
Copy link
Collaborator

closing, see #1434 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
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
@vcaldas @bug-or-feature