This week I worked on creating documetation and creating a web crawler for my new feature of providing users with option of installing packages from PythonLibs.
It’s really a great tool for creating docs. In just few steps I could create docs as compared to creating a whole website based on django or using static webpages on github.
We can create docs in few steps :
- Go to docs directory and run
- Navigate to
and change :
- Now run
sphinx-apidoc -f -o source/ ../mypackage/
- Our directory structure should be like this :
myproject/ |-- README |-- setup.py |-- myvirtualenv/ |-- mypackage/ | |-- __init__.py | `-- mymodule.py `-- docs/ |-- MakeFile |-- build/ `-- source/
- Finally run the following command to create html files from .rst files
We can also play with MakeFile to configure the settings based on our preference.