gsbDBI / ds-wgan

Design of Simulations using WGAN
MIT License
48 stars 16 forks source link

Expand docs carolin #7

Closed carolinthomas closed 4 years ago

carolinthomas commented 4 years ago

I have started writing the first draft for the documentation. For that, I changed the wgan.py file to hide the title and the attributes in the documentation.

evanmunro commented 4 years ago

I've pushed some commits with some updates to the content.

In addition, could you address the following before we merge?

Thanks for the great work!

evanmunro commented 4 years ago

Also, @Jonas-Metzger if you want, take a look at the current state of the docs in this branch and let us know if you have any comments or changes: (to generate them from source run make html in the docs folder, need a few extra python packages).

carolinthomas commented 4 years ago

@evanmunro I have changed the issues you addressed above.

evanmunro commented 4 years ago

still doesn't look quite right: when I click on Home, I don't need table of contents to appear both on the left sidebar and in the index.html. Right now Introduction only appears in the sidebar when I click on Home; if I click on one of the other sections it disappears from the sidebar.

carolinthomas commented 4 years ago

@evanmunro As far as I understand it, we need the table of contents in index.rst to create the sidebar, but I can double-check. I never have "Introduction" on the sidebar (please see the Screenshot), so do you want it included in the sidebar or not (I am not sure if we can include it)

Screen Shot 2019-11-11 at 10 58 01 AM

carolinthomas commented 4 years ago

@evanmunro I solved the issue with the table of content. Now, we only have a sidebar.