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

docs: add the base for the documentation #24

Merged
merged 2 commits into from
Aug 28, 2023
Merged

docs: add the base for the documentation #24

merged 2 commits into from
Aug 28, 2023

Conversation

MaferMazu
Copy link
Contributor

Description

This PR adds the structure for the documentation.

  • Create a requirements folder (for Python dependencies).
  • Create a global Makefile to update and make the documentation process.
  • Create the docs folder with the structure.
  • Add some base info about the plugin.

Screenshot from 2023-08-23 13-18-21

How to test

  • Create a Python virtual environment, and activate it.
  • Run make requirements
  • Enter in docs directory and run make html
  • Serve the doc with make serve_docs or python -m http.server 8200 --directory build/html

julianramirez2
julianramirez2 approved these changes Aug 24, 2023
View reviewed changes
Copy link
Contributor

@julianramirez2 julianramirez2 left a comment

Choose a reason for hiding this comment

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

Everything looks good for me.

@MaferMazu MaferMazu merged commit c762cb0 into main Aug 28, 2023
@felipemontoya felipemontoya deleted the mfmz/docs branch March 21, 2024 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julianramirez2 julianramirez2 julianramirez2 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
@MaferMazu @julianramirez2