Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
A
ansible
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
OpenEdx
ansible
Commits
80d6ca19
Commit
80d6ca19
authored
Dec 05, 2013
by
Jinn Koriech
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add README info for building the module documentation.
parent
6f284372
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
4 additions
and
1 deletions
+4
-1
docsite/README.md
+4
-1
No files found.
docsite/README.md
View file @
80d6ca19
...
@@ -7,7 +7,10 @@ Contributions to the documentation are welcome. To make changes, submit a pull
...
@@ -7,7 +7,10 @@ Contributions to the documentation are welcome. To make changes, submit a pull
that changes the reStructuredText files in the "rst/" directory only, and Michael can
that changes the reStructuredText files in the "rst/" directory only, and Michael can
do a docs build and push the static files. If you wish to verify output from the markup
do a docs build and push the static files. If you wish to verify output from the markup
such as link references, you may
[
install Sphinx
]
and build the documentation by running
such as link references, you may
[
install Sphinx
]
and build the documentation by running
`make viewdocs`
from the
`ansible/docsite`
directory.
`make viewdocs`
from the
`ansible/docsite`
directory. To include module documentation
you'll need to run
`make webdocs`
at the top level of the repository. The generated
html files are in docsite/htmlout/ and will require Wordpress to render correctly.
If you do not want to learn the reStructuredText format, you can also
[
file issues
]
about
If you do not want to learn the reStructuredText format, you can also
[
file issues
]
about
documentation problems on the Ansible GitHub project.
documentation problems on the Ansible GitHub project.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment