Skip to content
This repository has been archived by the owner on Mar 23, 2019. It is now read-only.

Docs are Terrible #10

Open
knappador opened this issue May 10, 2018 · 0 comments
Open

Docs are Terrible #10

knappador opened this issue May 10, 2018 · 0 comments
Labels
good first issue Good for newcomers

Comments

@knappador
Copy link
Owner

I went as far as actually getting the project to automatically update whenever master is merged. Hope into the docs/ folder and run sphinx-build -b html source build to obtain results in docs/build/ that can be opened in a browser to preview

They look something like this:
http://enron.readthedocs.io/en/latest/enron.html#module-enron.enron

I think the TOC and general page structure are not quite ready to be maintainable. I'd like to get this up to the point that simply inserting docstrings will result in helpful docs. A lot of the pages frankly just looked like confusing blobs.

I'm not rushing to go learn about configuring Sphinx until the API is stable 🚧 🏗️ 👷‍♂️

@knappador knappador added the good first issue Good for newcomers label May 10, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant