search

Billingegroup / cookiecutter

A cookie-cutter for DiffPy packages.
Other
0 stars 7 forks source link

Index for documentation #79

Closed Sparks29032 closed 3 weeks ago

Sparks29032 commented 3 weeks ago

Closes #63 Added release.rst that copies the CHANGELOG.rst in root. Change project short description in our test. image image image This image above assumes our README.rst has an installation section. If we do not want to mandate that, I will just link to the repo. image

sbillinge commented 3 weeks ago

This looks good.

I think that doctr will autobuild the API docs from the docstrings if I am not mistaken. Do we want to seed that section in the docs at least, so even if there are not other docs, the API will be documented? I am not sure about this, but it would be cool if by default we autobuilt such docs for each of our packages.....

Sparks29032 commented 3 weeks ago

I can test this to confirm, but I am not aware of this

Sparks29032 commented 3 weeks ago

New difference with index.rst: image

Difference compared to API source file (no references to specific diffpy.utils packages): image

When we use auto-doc we still need to manually put in the files formatting auto-doc. Next commit will add a sample package formatting.

Sparks29032 commented 3 weeks ago

With example modules: image

Note that the make html documentation build will fail for the user with the following message: image This will indicate to a developer that they should probably replace these sample assets when making their actual documentation. The errors in documentation will only occur when one attempts to build the docs, not when testing code or running the program.

sbillinge commented 3 weeks ago

thanks @Sparks29032 this is great.