osl-incubator / scicookie

Cookiecutter template for a Python package.
https://osl-incubator.github.io/scicookie
Other
10 stars 18 forks source link

feat(doc): adding API documentation for sphinx-rst and sphinx-md(myst) #289

Closed YurelyCamacho closed 1 month ago

YurelyCamacho commented 1 month ago

Pull Request description

Adding the API documentation for sphinx-md (myst) since it was already implemented for sphinx-rst.

Fixes #173 #174 #28

Pull Request checklists

This PR is a:

About this PR:

Author's checklist:

YurelyCamacho commented 1 month ago

@xmnlab Something is going on with makim because it is not automatically generating the html files. Locally I had to run:

makim docs.build
sphinx-build -M html docs/ docs/_build/
cd docs/_build/html && python -m http.server

And it works but there is still something to be solved. Note: When testing on a template with make, the commands docs-build and docs-preview work.

YurelyCamacho commented 1 month ago

@xmnlab Right now it is not deleting the docs-sphinx folder and I think that is why it is not finding the conf.py file.

xmnlab commented 1 month ago

thanks for working on that @YurelyCamacho !

xmnlab commented 1 month ago

good job!