Skip to content

Commit

Permalink
move documentation to the doc folder.
Browse files Browse the repository at this point in the history
  • Loading branch information
millermedeiros committed Aug 8, 2012
1 parent 2f66187 commit 12d3d48
Show file tree
Hide file tree
Showing 98 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions README.mdown
Expand Up @@ -99,14 +99,14 @@ Released under the [MIT License](http://www.opensource.org/licenses/mit-license.
## Building The Documentation ##

The documentation is generated based on markdown files inside the
`_build/doc/content` folder using [mdoc](https://github.com/millermedeiros/mdoc).
`doc/mdown` folder using [mdoc](https://github.com/millermedeiros/mdoc).
To compile the docs run:

npm install .
node build.js
node build

It will replace all the files inside the `doc/` folder and update packages and
specs runners, this way we avoid human mistakes.
It will replace all the files inside the `doc/html` folder and update packages
and specs runners, this way we avoid human mistakes.

Documentation files should be always up-to-date since modules are only
committed to the `master` branch after they get proper tests and documentation.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions build.js
Expand Up @@ -5,11 +5,11 @@
var mdoc = require('mdoc');

mdoc.run({
inputDir : '_build/doc/content',
outputDir : 'doc',
inputDir : 'doc/mdown',
outputDir : 'doc/html',
baseTitle : 'AMD-Utils',
indexContentPath : 'README.mdown',
templatePath : '_build/doc/template'
templatePath : '_build/doc_template'
});


Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions doc/index.html → doc/html/index.html
Expand Up @@ -114,15 +114,15 @@ <h2>License</h2>
<h2>Building The Documentation</h2>

<p>The documentation is generated based on markdown files inside the
<code>_build/doc/content</code> folder using <a href="https://github.com/millermedeiros/mdoc">mdoc</a>.
<code>doc/mdown</code> folder using <a href="https://github.com/millermedeiros/mdoc">mdoc</a>.
To compile the docs run:</p>

<pre><code>npm install .
node build.js
node build
</code></pre>

<p>It will replace all the files inside the <code>doc/</code> folder and update packages and
specs runners, this way we avoid human mistakes.</p>
<p>It will replace all the files inside the <code>doc/html</code> folder and update packages
and specs runners, this way we avoid human mistakes.</p>

<p>Documentation files should be always up-to-date since modules are only
committed to the <code>master</code> branch after they get proper tests and documentation.</p>
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions updateDocs.sh
Expand Up @@ -4,9 +4,9 @@
git checkout gh-pages
rm *.html
rm -r assets_/
git checkout master doc
mv doc/* .
rmdir doc
git checkout master doc/html
mv doc/html/* .
rm -r doc/
git add -A
git commit
git checkout master

0 comments on commit 12d3d48

Please sign in to comment.