Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: adding sphinx documentation for the dandi-cli #712

Merged
merged 10 commits into from
Jul 16, 2021
Merged

Commits on Jul 14, 2021

  1. Configuration menu
    Copy the full SHA
    56333d7 View commit details
    Browse the repository at this point in the history
  2. DOC: skeleton made by sphinx-quickstart for sphinx docs

    conf.py got tuned up by black after
    
    	(git)lena:~/proj/dandi/dandi-cli-master[enh-sphinx]docs
    	$> sphinx-quickstart
    	Welcome to the Sphinx 3.4.3 quickstart utility.
    
    	Please enter values for the following settings (just press Enter to
    	accept a default value, if one is given in brackets).
    
    	Selected root path: .
    
    	You have two options for placing the build directory for Sphinx output.
    	Either, you use a directory "_build" within the root path, or you separate
    	"source" and "build" directories within the root path.
    	> Separate source and build directories (y/n) [n]: y
    
    	The project name will occur in several places in the built documentation.
    	> Project name: DANDI Archive CLI and Python API library
    	> Author name(s): DANDI Team
    	> Project release []: TODOdandi.__version__
    
    	If the documents are to be written in a language other than English,
    	you can select a language here by its language code. Sphinx will then
    	translate text that it generates into that language.
    
    	For a list of supported codes, see
    	https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language.
    	> Project language [en]:
    
    	Creating file /home/yoh/proj/dandi/dandi-cli-master/docs/source/conf.py.
    	Creating file /home/yoh/proj/dandi/dandi-cli-master/docs/source/index.rst.
    	Creating file /home/yoh/proj/dandi/dandi-cli-master/docs/Makefile.
    	Creating file /home/yoh/proj/dandi/dandi-cli-master/docs/make.bat.
    
    	Finished: An initial directory structure has been created.
    
    	You should now populate your master file /home/yoh/proj/dandi/dandi-cli-master/docs/source/index.rst and create other documentation
    	source files. Use the Makefile to build the docs, like so:
    	   make builder
    	where "builder" is one of the supported builders, e.g. html, latex or linkcheck.
    yarikoptic committed Jul 14, 2021
    Configuration menu
    Copy the full SHA
    c82d191 View commit details
    Browse the repository at this point in the history

Commits on Jul 15, 2021

  1. initial bits and pieces

    yarikoptic committed Jul 15, 2021
    Configuration menu
    Copy the full SHA
    481b620 View commit details
    Browse the repository at this point in the history
  2. Build with tox

    jwodder committed Jul 15, 2021
    Configuration menu
    Copy the full SHA
    02bf07f View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    5c1348c View commit details
    Browse the repository at this point in the history
  4. More docs pages

    jwodder committed Jul 15, 2021
    Configuration menu
    Copy the full SHA
    d8ae55e View commit details
    Browse the repository at this point in the history
  5. Make --jobs arg consistent

    jwodder committed Jul 15, 2021
    Configuration menu
    Copy the full SHA
    b6224fb View commit details
    Browse the repository at this point in the history

Commits on Jul 16, 2021

  1. Add "Build Docs" workflow

    jwodder committed Jul 16, 2021
    Configuration menu
    Copy the full SHA
    385fbe8 View commit details
    Browse the repository at this point in the history
  2. Typo

    jwodder committed Jul 16, 2021
    Configuration menu
    Copy the full SHA
    6ef7fa9 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    7b6a862 View commit details
    Browse the repository at this point in the history