search

QuantEcon / jupinx

Jupyter + Sphinx Utilities and Tools
https://quantecon.github.io/jupinx/
20 stars 4 forks source link

FEAT: Quickstart feature #6

Closed AakashGfude closed 5 years ago

AakashGfude commented 5 years ago

The functionalities implemented at present are as follows :-

  1. Few basic quickstart questions have been implemented like a. Enter the root path for documentation.

    Root path for the documentation [.]: b. The project name will occur in several places in the built documentation. Project name: Author name(s): c. > Project version []: Project release []: d. > Project language [en]: (uses sphinx for translation) e. Indicate which of the following Sphinx extensions should be installed: -- if sphinxcontrib-jupyter is installed then following question pops up - sphinxcontrib-jupyter package has been found in your system. Would you like to upgrade it? (y/n) [y]: -- else - sphinxcontrib-jupyter: A Sphinx Extension for Generating Jupyter Notebooks (y/n) [y]:

  2. After the quickstart prompt, an initial directory structure similar to lecture-source-py is created (with conf.py at the root level).
  3. Basic templates to be used for creating Makefile ,conf.py and index.rst have been implemented.
mmcky commented 5 years ago

thanks @AakashGfude this is a great starting point. I will merge this as is and then we can iterate on questions and additional setup (as required).