-
-
Notifications
You must be signed in to change notification settings - Fork 9
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
Replace sphinx with mkdocs and move setup.cfg to pyproject.toml #108
Conversation
Pull Request Test Coverage Report for Build 6441160223227904
💛 - Coveralls |
Hi @FlorianWilhelm, thank you very much for the huge amount of work you are pouring into this... Do we need to pull in Would ignore the warnings be a valid option for handling this problem? If this problem was reported in |
@abravalheri, There are mainly 2 questions:
P.S.: If we want to go for 1) we could use your |
@abravalheri: Regarding ignoring the warnings, I am not sure it really is considered a bug in Sphinx napoleon, from all I understand I would rather say it's a kind of design decision for them but I might also be wrong. |
Hi @FlorianWilhelm,
Definitely! There is some initial work contributed to the dev branch, but I have been very slow lately :P
I have no objection on that front, in fact we can use this opportunity and extract templates either for PyScaffold itself or Do you know what are the main advantages of mkdocs over sphinx+MyST? |
Okay, then I would suggest I wait a little longer until there is a state of PyScaffold that we can try to automatically update ConfigUpdater, which I can then try out to move it to Regarding Sphinx vs. mkdocs, let's then stay with Sphinx+MyST :-) Surely Sphinx with all its extensions is still way more powerful than mkdocs. For some tiny side projects I just tend to use mkdocs since it's so much simpler and I can do everything in a toml file and per default it's markdown. Let's close this PR for now then :-) |
It seems that there are a few issues open in sphinx that might be related to this. One of them seem to have some traction and the overall idea seems to be supported by the leading dev (although no implementation is available yet).
Yes that is probably |
Trying to fix those Sphinx warnings from #90 one way or another.