Comments (2)
Agreed (especially on MD vs rST 😓), but per our discussion yesterday I think there might be two separate use cases - not sure Mkdocs actually replaces Sphinx for code documentation. (Some limited discussion here: mkdocs/mkdocs#20)
As a counterargument, do we really expect people to write full-on docstrings in most data science code? Most of the time I'd probably choose lightweight set of doc pages like (approach, dev setup, deployment) over heavy duty Sphinx docs.
My vote is actually to allow either as a cookiecutter option.
from cookiecutter-data-science.
Mkdocs do not generate PDF from MD. Sphinx can generate PDF from MD http://www.sphinx-doc.org/en/stable/markdown.html
from cookiecutter-data-science.
Related Issues (20)
- Support user-supplied config files
- Improve the quality of the boilerplate python code HOT 1
- Switch from sphinx as default project docs to mkdocs
- Add Python 3.12 support HOT 4
- More documentation for newcomers
- Dry run of ownership transfer HOT 2
- Announce v2 release HOT 1
- add documentation for running make on Windows HOT 8
- Make v1 template docs accessible in new docs
- Termynal markdown page should not be included HOT 1
- v2 release logistics checklist HOT 1
- ideas for documentation about just+pyproject.toml+mkdocs
- Defend against broken paths from non-editable installs
- Document how to use the Python source code scaffolding
- Document conda-forge as a way to install make
- Option for Poetry support for package managent
- Update directory structure in README to reflect v2
- Add tag for v2 HOT 1
- Release package on conda-forge
- Add badges to README
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cookiecutter-data-science.