This repository would be useful as a reference for documentation with Python 3 and Sphinx. There is also a short blog post on this on my website.
It is strongly recommended to watch Brandon Rhodes's Sphinx tutorial session at PyCon 2013 and leimao's blog post.
.
├── Makefile
├── README.md
├── build
├── doc
│ ├── Makefile
│ ├── README.md
│ ├── __init__.py
│ ├── build
│ ├── make.bat
│ └── source
│ ├── _static
│ ├── _templates
│ ├── api.rst
│ ├── conf.py
│ ├── guide.rst
│ └── index.rst
├── leetcode
│ ├── __init__.py
│ ├── impl
│ │ └── solution.py
│ └── mocktest.py
├── make.bat
├── requirements.txt
└── source
├── _static
├── _templates
├── conf.py
└── index.rst
The leetcode folder used for the tutorial has no dependency. But for completeness, we added setuptools and sphinx to our requirements.txt.
To install the dependencies, please run the following command in the terminal.
$ pip install -r requirements.txt
To install the leetcode, which we would not probably do, please run the following command in the terminal.
$ pip install .
Please check the README in docs for details.
When being stuck, there are a few things you can do to give yourself hints: 1. Look at the tag for the problem and see what kind of algorithm or data structure is needed for solving 2. Look at the hints provided by Leetcode 3. Quickly look at the discussion title to see what the expected complexity is or the algorithm. 4. Estimate the Time Complexity of the problem based on the input constraints.