-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add Documentation/README.rst to point GitHub users to ReadTheDocs
Signed-off-by: Jesper Dangaard Brouer <brouer@redhat.com>
- Loading branch information
1 parent
1e30b06
commit f51eb31
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
Documentation | ||
============= | ||
|
||
This documentation is avail at: `prototype-kernel.readthedocs.io`_ | ||
|
||
Files in this Documentation/ directory is (like the kernel) based on | ||
`reStructuredText`_ files and `Sphinx`_ can be used for generating | ||
pretty documentation. Just like this documentation is being | ||
auto-generated on `Read The Docs`_. | ||
|
||
Compiling | ||
--------- | ||
|
||
To generate pretty `Sphinx`_ documentation locally simply run :: | ||
|
||
make html | ||
|
||
The generate output will be located in ``_build/html/index.html`` | ||
(`local link`_) | ||
|
||
.. _Read The Docs: https://prototype-kernel.readthedocs.io | ||
.. _prototype-kernel.readthedocs.io: https://prototype-kernel.readthedocs.io | ||
.. _Sphinx: http://www.sphinx-doc.org/ | ||
.. _reStructuredText: http://docutils.sourceforge.net/rst.html | ||
.. _local link: file:///home/hawk/git/prototype-kernel/kernel/Documentation/_build/html/index.html | ||
|