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

HELP WANTED | Let's switch to Markdown & mkdocs - from restructuredText & Sphinx #347

Draft
wants to merge 30 commits into
base: dev
Choose a base branch
from
Draft

HELP WANTED | Let's switch to Markdown & mkdocs - from restructuredText & Sphinx #347

wants to merge 30 commits into from

Conversation

funilrys
Copy link
Owner

As mentioned in #340, it's time to move away from restructured text.

This PR is a work in progress. - feel free to contribute!

@funilrys
Remove README.rst switch to README.md.
847326c
@funilrys
Rename CODE_OF_CONDUCT.rst to CODE_OF_CONDUCT_md.
c70742b
@funilrys
Rename CONTRIBUTING.rst to CONTRIBUTING.md.
ee25566
@funilrys
Switch format to markdown.
c9d06db
@funilrys
Fix typo.
d70d226
@funilrys
Store current state.
ba04b02
@funilrys
Update CONTRIBUTING.md.
b1f4565
@funilrys
Update CODE_OF_CONDUCT.md.
a3286b7
@funilrys
Add all-contributors flag.
250b541
@funilrys
Add .all-contributorsrc.
0a4e54c
@funilrys
Add more pages into new documentation.
1c795c7
@funilrys
Update documentation.
f3e60a1
@funilrys
Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs
8c16f7b
@funilrys
Update state.
d51c966
@funilrys
Add more pages.
0c55bad
@funilrys
Add support for sphinx-format.
1571b66
@funilrys
Add git instruction - when necessary.
1c05886
@funilrys
Add warning about chancy mode.
736a86f
@funilrys
Clarify purpose of docs/gen_ref_pages.py script.
bd6579a
@funilrys
Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs
6789b99
@funilrys
Update documentation.
0605e6a
@funilrys
Merge remote-tracking branch 'origin/dev' into switch-to-mkdocs
6abfd06
@funilrys
Add getting started and examples pages.
73467f5
@funilrys
Update showcase gif.
8a82dd0
@funilrys
Fix some typos and semantics.
4557872
@funilrys funilrys self-assigned this Dec 19, 2023
@funilrys funilrys linked an issue Dec 19, 2023 that may be closed by this pull request
DOC: Moving away from restructured text #340
Open
@coveralls
Copy link

coveralls commented Dec 19, 2023 •
edited

Coverage Status

coverage: 95.26%. first build
when pulling baea2ba on switch-to-mkdocs
into 04826e2 on dev.

@spirillen
Copy link
Contributor

You should make sure`material.extensions' gets installed... (#340 (comment))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@funilrys funilrys

Labels
None yet
Projects
#PyFunceble Documentation
Status: In progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

DOC: Moving away from restructured text
3 participants
@funilrys @coveralls @spirillen