Skip to content

Revamped docs system#675

Merged
sergeyk merged 4 commits intoBVLC:masterfrom
sergeyk:master
Jul 12, 2014
Merged

Revamped docs system#675
sergeyk merged 4 commits intoBVLC:masterfrom
sergeyk:master

Conversation

@sergeyk
Copy link
Copy Markdown
Contributor

@sergeyk sergeyk commented Jul 11, 2014

A couple of major changes:

  • documentation of an example now lives in the example folder
  • build_docs script assembles the example documentation and ipython notebooks and automatically creates a table of contents in index.md

The motivation:

  • make examples and example notebooks easier to contribute: no need to touch docs/ at all
  • make example documentation more easily usable: no need to fire up doc server, just look at corresponding readme
  • a step toward more complete documentation of the code, automatically assembled from readme's and docstrings

@shelhamer take a look, comment to approve -- i can merge

@shelhamer
Copy link
Copy Markdown
Member

Nice arrangement! I like the new scheme. Please address my comments, make sure you didn't miss adding anything (remember git add -f since examples are ignored by default to dodge the hassle of accidentally versioning or working around variations), and double-check this all builds and deploys right -- I just had a quick glance.

That said, go ahead and merge then back-merge to dev when you like! Thanks Sergey.

sergeyk added a commit that referenced this pull request Jul 12, 2014
@sergeyk sergeyk merged commit e8e8292 into BVLC:master Jul 12, 2014
sergeyk added a commit that referenced this pull request Jul 12, 2014
mitmul pushed a commit to mitmul/caffe that referenced this pull request Sep 30, 2014
RazvanRanca pushed a commit to RazvanRanca/caffe that referenced this pull request Nov 4, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants