зеркало из https://github.com/microsoft/caffe.git
[docs] shelhamer's minor suggestions
This commit is contained in:
Родитель
54c94190a9
Коммит
05d661f042
|
@ -9,7 +9,7 @@ The [BVLC](http://bvlc.eecs.berkeley.edu/) maintainers welcome all contributions
|
|||
|
||||
### Documentation
|
||||
|
||||
This website, written with [Jekyll](http://jekyllrb.com/), functions as the documentation portal -- simply run `scripts/build_docs.sh` and view the website at `http://0.0.0.0:4000`.
|
||||
This website, written with [Jekyll](http://jekyllrb.com/), functions as the official Caffe documentation -- simply run `scripts/build_docs.sh` and view the website at `http://0.0.0.0:4000`.
|
||||
|
||||
We prefer tutorials and examples to be documented close to where they live, in `readme.md` files.
|
||||
The `build_docs.sh` script gathers all `examples/**/readme.md` and `examples/*.ipynb` files, and makes a table of contents.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: ImageNet tutorial
|
||||
description: Train and test "AlexNet" on ImageNet challenge data.
|
||||
description: Train and test "CaffeNet" on ImageNet challenge data.
|
||||
category: example
|
||||
include_in_docs: true
|
||||
layout: default
|
||||
|
|
|
@ -6,15 +6,16 @@ ROOT_DIR="$( cd "$(dirname "$0")"/.. ; pwd -P )"
|
|||
cd $ROOT_DIR
|
||||
|
||||
# Gather docs from examples/**/readme.md
|
||||
rm -r docs/gathered
|
||||
mkdir docs/gathered
|
||||
GATHERED_DIR=docs/gathered
|
||||
rm -r $GATHERED_DIR
|
||||
mkdir $GATHERED_DIR
|
||||
for README_FILENAME in $(find examples -iname "readme.md"); do
|
||||
# Only use file if it is to be included in docs.
|
||||
if grep -Fxq "include_in_docs: true" $README_FILENAME; then
|
||||
# Make link to readme.md in docs/gathered/.
|
||||
# Since everything is called readme.md, rename it by its dirname.
|
||||
README_DIRNAME=`dirname $README_FILENAME`
|
||||
DOCS_FILENAME=docs/gathered/$README_DIRNAME.md
|
||||
DOCS_FILENAME=$GATHERED_DIR/$README_DIRNAME.md
|
||||
mkdir -p `dirname $DOCS_FILENAME`
|
||||
ln -s $ROOT_DIR/$README_FILENAME $DOCS_FILENAME
|
||||
fi
|
||||
|
@ -22,7 +23,7 @@ done
|
|||
|
||||
# Gather docs from examples/*.ipynb and add YAML front-matter.
|
||||
for NOTEBOOK_FILENAME in $(find examples -d 1 -iname "*.ipynb"); do
|
||||
DOCS_FILENAME=docs/gathered/$NOTEBOOK_FILENAME
|
||||
DOCS_FILENAME=$GATHERED_DIR/$NOTEBOOK_FILENAME
|
||||
mkdir -p `dirname $DOCS_FILENAME`
|
||||
python scripts/copy_notebook.py $NOTEBOOK_FILENAME $DOCS_FILENAME
|
||||
done
|
||||
|
|
Загрузка…
Ссылка в новой задаче