search

p-christ / nn_builder

Build neural networks with less boilerplate code
MIT License
162 stars 22 forks source link

Documentation site #7

Open p-christ opened 5 years ago

p-christ commented 5 years ago

We need a site to host documentation for the module. This could potentially be done with GitHub Pages

TannerGilbert commented 4 years ago

There are multiple tools to create your documentation. Do you have any specific tool in mind?

p-christ commented 4 years ago

Hi! I don't really know about the available tools, are there any you'd recommend?

TannerGilbert commented 4 years ago

For creating a documentation website there are many tools available: docsify, Docusaurus, VuePress, Sphinx.

I have experience in VuePress but I'm sure I could get the other ones to work as well. Regarding hosting all of them can be hosted as a static page on Github Pages or any other hosting platform

kbaran1998 commented 1 year ago

I would recommend Mk-Docs Material. It creates a very clean, searchable and styling is customisable. You can also host it as a static site on GitHub Pages.