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.

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

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

Closed
wants to merge 52 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 funilrys self-assigned this Dec 19, 2023
@funilrys funilrys linked an issue Dec 19, 2023 that may be closed by this pull request
@coveralls
Copy link

coveralls commented Dec 19, 2023

Coverage Status

coverage: 94.723%. remained the same
when pulling 4c20487 on switch-to-mkdocs
into f848dc9 on dev.

@funilrys
Copy link
Owner Author

After each push into the switch-to-mkdocs branch, a new documentation will be published to https://hub.docker.com/r/pyfunceble/docs
and later automatically fetched and readable from https://docs.pyfunceble.com.

cc: @mitchellkrogza @spirillen

@spirillen
Copy link
Contributor

After each push into the switch-to-mkdocs branch, a new documentation will be published to https://hub.docker.com/r/pyfunceble/docs and later automatically fetched and readable from https://docs.pyfunceble.com.

cc: @mitchellkrogza @spirillen

I have made a fork and moved to https://github.com/foreign-affairs/PyFunceble-docs this repo will de docs only, and the default branch are changed to switch-to-mkdocs so for ease, would it be possible we made changes there, and then pushed here?

@spirillen
Copy link
Contributor

What is destination folder and what is the old docs?

I assume https://github.com/funilrys/PyFunceble/tree/switch-to-mkdocs/docs is the new target while https://github.com/funilrys/PyFunceble/tree/switch-to-mkdocs/sphinx-docs should be considered as the source. right?

@funilrys funilrys marked this pull request as ready for review September 21, 2024 19:00
@funilrys
Copy link
Owner Author

merged. closing.

@funilrys funilrys closed this Sep 21, 2024
Copy link

@funilrys

We had trouble processing your request. Please try again later.

@funilrys
Copy link
Owner Author

@all-contributors please add @avatartw for bug.

Copy link

@funilrys

We had trouble processing your request. Please try again later.

2 similar comments
Copy link

@funilrys

We had trouble processing your request. Please try again later.

Copy link

@funilrys

We had trouble processing your request. Please try again later.

@funilrys funilrys deleted the switch-to-mkdocs branch October 3, 2024 13:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

DOC: Moving away from restructured text
3 participants