Home page

Deconstructing Deep Learning + ╬┤eviations

Drop me an email | RSS feed link : Click
Format : Date | Title
  TL; DR

Total posts : 80

View My GitHub Profile


Index page

Automatic Documentation Website Generator ;others

Ever made a library, added documentation and then thought "ugh I need to make this into a website. Why is it so much work?". Here is the solution to your problems. Actually making a library not included. (oops)

Note that this only works for python so far. I have tested it on Linux. Which means it should work on Linux/mac/WSL with no issues. Windows.. you might need to change the shell commands.

Examples

Prerequisites

Here are the steps:

pdoc --force --html -o docs libraryname

This should generate the required files. - Now for the hacky part of it. (It works trust me)

mv docs/libraryname/index.html docs/index.md
mv docs/libraryname/* docs/

Some tips

chmod +x pusher.sh
pdoc --force --html -o docs libraryname
mv docs/libraryname/index.html docs/index.md
mv docs/libraryname/* docs/