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.

Sign up for GitHub

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

Jump to bottom

ReST-based automatic documentation #17

Closed
4 tasks done
inureyes opened this issue Jul 7, 2017 · 1 comment
Closed
4 tasks done

ReST-based automatic documentation #17

inureyes opened this issue Jul 7, 2017 · 1 comment
Assignees
@achimnol @inureyes
Projects
MLJejuCamp
Milestone
1.0.0

Comments

@inureyes
Copy link
Collaborator

inureyes commented Jul 7, 2017 •
edited by ragulpr

  • For easier using and deeper understanding about the project, we need solid and synchronized documentation for the project.
  • Also, tool-based documentation reduces the requirements for separated instruction site & technical documentations

Plan

  • Write concrete comment on source code
  • Match comments to be ReStructuredText format
  • Make documentation generation scripts
  • Setup readthedocs
@inureyes inureyes self-assigned this Jul 7, 2017
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
refs #17 : add - sphinx-docs configuration file and directories
0bcc66f
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
refs #17 : modify - sphinx-docs
d7dc6bf
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
refs #17 : add - description about utility functions
66ef889
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
refs #17 : add - ReST-style format code comments
8efea9f 
 * covering current whole python codes
 * Need to test and refine.
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
refs #17 : modify - add git commit exceptions (sphinx)
494e5ab
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
Merge branch 'feature/#17-ReST-based_automatic_documentation'
a1041ee
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
refs #17 : modify - ignore .idea directory (IntelliJ)
3bfd0ef
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
refs #17 : add - comments on weibull-related calculation aliases
a618002
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
Merge branch 'feature/#17-ReST-based_automatic_documentation'
f35743e
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
refs #17 : add - comments on objective functions for TensorFlow
2e13d96
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
Merge branch 'feature/#17-ReST-based_automatic_documentation'
af11a15
inureyes added a commit that referenced this issue Jul 7, 2017
@inureyes
refs #17 : add - sphinx and theme file for docs
6239976
inureyes added a commit that referenced this issue Jul 8, 2017
@inureyes
refs #17 : modify - support python2 sphinx
36e25a1
ragulpr added a commit that referenced this issue Jul 11, 2017
@ragulpr
refs #17 minor docstring fixes
0069da7
ragulpr added a commit that referenced this issue Jul 14, 2017
@ragulpr
Merge branch 'feature/#17-ReST-based_automatic_documentation' into de…
1fe9a76 
…velop
ragulpr added a commit that referenced this issue Jul 18, 2017
@ragulpr
Merge branch 'feature/#17-ReST-based_automatic_documentation' into de…
1bfbcb9 
…velop
ragulpr added a commit that referenced this issue Jul 18, 2017
@ragulpr
refs #17 : Fix formatting
ef761a9
ragulpr added a commit that referenced this issue Jul 18, 2017
@ragulpr
refs #17 : Fix formatting
45f4f23
ragulpr added a commit that referenced this issue Jul 18, 2017
@ragulpr
Merge branch 'feature/#17-ReST-based_automatic_documentation' into de…
3d0fe10 
…velop
@inureyes inureyes modified the milestone: 1.0.0 Jul 20, 2017
ragulpr added a commit that referenced this issue Jul 24, 2017
@ragulpr
refs #17: Added rtfd-requirements.txt
835c739 
See readthedocs/readthedocs.org#1814

Supposedly fixes `WARNING: html_static_path entry .. does not exist`
ragulpr added a commit that referenced this issue Jul 24, 2017
@ragulpr
refs #17 test removing static path
a1b5912 
see https://github.com/terasolunaorg/guideline/issues/1358
ragulpr added a commit that referenced this issue Jul 24, 2017
@ragulpr
refs #17: Test fixing rtfd-requirements.txt
7a731dc
ragulpr added a commit that referenced this issue Jul 24, 2017
@ragulpr
refs #17: Removing rtfd-requirements.txt. Not working
455392e
achimnol added a commit that referenced this issue Jul 24, 2017
@achimnol
refs #17, #19: Clean up requirements for documentations.
e3496d3 
 * We should set "python/requirements-docs.txt" in RTD's advanced
   settings.
achimnol added a commit that referenced this issue Jul 24, 2017
@achimnol
refs #17: In the real RTD site, we should NOT install sphinx-rtd-theme.
d7735ae
achimnol added a commit that referenced this issue Jul 24, 2017
@achimnol
refs #17: Fix typo
95c533c
achimnol added a commit that referenced this issue Jul 24, 2017
@achimnol
refs #17: Merge docs/rtfd-requirements.txt and python/requirements-do…
f8bdca9 
…cs.txt

 * Make sphinx_rtd_theme installed ONLY in development setups.
achimnol added a commit that referenced this issue Jul 24, 2017
@achimnol
refs #17: Ooops, merge mistake!
48504fc
achimnol added a commit that referenced this issue Jul 24, 2017
@achimnol
refs #17: Adapt CI/RTD scripts to fit with our directory structure
ea31e49
achimnol added a commit that referenced this issue Jul 24, 2017
@achimnol
refs #17: Use autodoc and sphinx-apidoc to generate docs from docstring
344eae4 
 * Add an empty example documentation
achimnol added a commit that referenced this issue Jul 24, 2017
@achimnol
refs #17: Update build-docs.sh and arguments to apidoc main.
153410a 
 * apidoc is automatically called by conf.py
achimnol added a commit that referenced this issue Jul 24, 2017
@achimnol
refs #17, #23: Update/clean up READMEs
047b38f
inureyes added a commit that referenced this issue Jul 25, 2017
@inureyes
refs #17 : bugfix - typo
56c296d 
 * add : detailed title for readme.md (For python dir.)
inureyes added a commit that referenced this issue Jul 25, 2017
@inureyes
refs #17 : modify - typo (Weibull dist.)
3f5dc6b
inureyes added a commit that referenced this issue Jul 25, 2017
@inureyes
Merge branch 'develop' into feature/#17-ReST-based_automatic_document…
41bd41b 
…ation
ragulpr added a commit that referenced this issue Jul 25, 2017
@ragulpr
refs #17 : conf.py from __future__ import print_function
11e97ea
achimnol added a commit that referenced this issue Jul 25, 2017
@achimnol
refs #17: Reorganize README sections (status and roadmap)
f40fffd
ragulpr added a commit that referenced this issue Jul 25, 2017
@ragulpr
refs #17 : Fixed docstring
184ff66
@ragulpr
Copy link
Owner

ragulpr commented Jul 26, 2017

http://wtte-rnn.readthedocs.io/en/master/ great work everybody!

@ragulpr ragulpr closed this as completed Jul 26, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@achimnol achimnol

@inureyes inureyes

Labels
None yet
Projects
MLJejuCamp
Awaiting triage
Milestone
1.0.0
Development

No branches or pull requests
3 participants
@achimnol @inureyes @ragulpr