-
Notifications
You must be signed in to change notification settings - Fork 28
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
Commits on Jul 14, 2021
-
Configuration menu - View commit details
-
Copy full SHA for 56333d7 - Browse repository at this point
Copy the full SHA 56333d7View commit details -
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.
Configuration menu - View commit details
-
Copy full SHA for c82d191 - Browse repository at this point
Copy the full SHA c82d191View commit details
Commits on Jul 15, 2021
-
Configuration menu - View commit details
-
Copy full SHA for 481b620 - Browse repository at this point
Copy the full SHA 481b620View commit details -
Configuration menu - View commit details
-
Copy full SHA for 02bf07f - Browse repository at this point
Copy the full SHA 02bf07fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 5c1348c - Browse repository at this point
Copy the full SHA 5c1348cView commit details -
Configuration menu - View commit details
-
Copy full SHA for d8ae55e - Browse repository at this point
Copy the full SHA d8ae55eView commit details -
Configuration menu - View commit details
-
Copy full SHA for b6224fb - Browse repository at this point
Copy the full SHA b6224fbView commit details
Commits on Jul 16, 2021
-
Configuration menu - View commit details
-
Copy full SHA for 385fbe8 - Browse repository at this point
Copy the full SHA 385fbe8View commit details -
Configuration menu - View commit details
-
Copy full SHA for 6ef7fa9 - Browse repository at this point
Copy the full SHA 6ef7fa9View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7b6a862 - Browse repository at this point
Copy the full SHA 7b6a862View commit details
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.