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: change to sphinx docs #288

Merged
merged 7 commits into from
Feb 27, 2023
Merged

docs: change to sphinx docs #288

merged 7 commits into from
Feb 27, 2023

Conversation

kemingy
Copy link
Member

@kemingy kemingy commented Feb 25, 2023

Pros

  • looks better for the API interface part
  • Python ecosystem

Cons

  • the doc of sphinx and myst_parser is not great

@kemingy
docs: change to sphinx docs
7fa8537 
Signed-off-by: Keming <kemingy94@gmail.com>
@kemingy
fix pages ci
247e79e 
Signed-off-by: Keming <kemingy94@gmail.com>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 25, 2023
@kemingy
rebase main
e714397 
Signed-off-by: Keming <kemingy94@gmail.com>
@kemingy
Copy link
Member Author

kemingy commented Feb 25, 2023

TODO

  • docstrings are not compatible with sphinx

You can build the doc site with make doc locally.

@kemingy
Copy link
Member Author

kemingy commented Feb 26, 2023

TODO

* docstrings are not compatible with sphinx

We can add some patches to support Markdown in docstrings. It might be possible to officially support Markdown in the future.

@kemingy
fix rst
851f5db 
Signed-off-by: Keming <kemingy94@gmail.com>
@kemingy
Copy link
Member Author

kemingy commented Feb 27, 2023

TODO

* docstrings are not compatible with sphinx

* Refer to [Allow for autodoc to parse Markdown docstrings executablebooks/MyST-Parser#228](https://github.com/executablebooks/MyST-Parser/issues/228)

We can add some patches to support Markdown in docstrings. It might be possible to officially support Markdown in the future.

Let's use the default reStructuredText format for now. 😢

@kemingy
fix ci for pages
590b637 
Signed-off-by: Keming <kemingy94@gmail.com>
lkevinzc
lkevinzc reviewed Feb 27, 2023
View reviewed changes
Copy link
Member

@lkevinzc lkevinzc left a comment

Choose a reason for hiding this comment

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

I think we can temporarily remove the DEV GUIDE/Design section.

mosec/worker.py Outdated Show resolved Hide resolved
kemingy and others added 2 commits February 27, 2023 10:40
@kemingy @lkevinzc
Update mosec/worker.py
29a9d3a 
Co-authored-by: zclzc <38581401+lkevinzc@users.noreply.github.com>
Signed-off-by: Keming <kemingy94@gmail.com>
@kemingy
rm design doc
0e517be 
Signed-off-by: Keming <kemingy94@gmail.com>
@kemingy
Copy link
Member Author

kemingy commented Feb 27, 2023

I think we can temporarily remove the DEV GUIDE/Design section.

Removed.

@lkevinzc lkevinzc self-requested a review February 27, 2023 02:42
@kemingy kemingy merged commit b4eab0d into mosecorg:main Feb 27, 2023
@kemingy kemingy deleted the sphinx branch February 27, 2023 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lkevinzc lkevinzc lkevinzc approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kemingy @lkevinzc