Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F98810743
sphinx_howto.html
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Thu, Jan 16, 14:54
Size
3 KB
Mime Type
text/html
Expires
Sat, Jan 18, 14:54 (2 d)
Engine
blob
Format
Raw Data
Handle
23650092
Attached To
rOACCT Open Access Compliance Check Tool (OACCT)
sphinx_howto.html
View Options
<!DOCTYPE html>
<html>
<head>
<meta
charset=
"utf-8"
/>
<meta
name=
"viewport"
content=
"width=device-width, initial-scale=1.0"
/><meta
name=
"generator"
content=
"Docutils 0.17.1: http://docutils.sourceforge.net/"
/>
<title>
How to update documentation?
—
OACCT 0.1 documentation
</title>
<link
rel=
"stylesheet"
type=
"text/css"
href=
"_static/pygments.css"
/>
<link
rel=
"stylesheet"
type=
"text/css"
href=
"_static/alabaster.css"
/>
<script
data-url_root=
"./"
id=
"documentation_options"
src=
"_static/documentation_options.js"
></script>
<script
src=
"_static/jquery.js"
></script>
<script
src=
"_static/underscore.js"
></script>
<script
src=
"_static/doctools.js"
></script>
<link
rel=
"index"
title=
"Index"
href=
"genindex.html"
/>
<link
rel=
"search"
title=
"Search"
href=
"search.html"
/>
<link
rel=
"prev"
title=
"manage module"
href=
"manage.html"
/>
<link
rel=
"stylesheet"
href=
"_static/custom.css"
type=
"text/css"
/>
<meta
name=
"viewport"
content=
"width=device-width, initial-scale=0.9, maximum-scale=0.9"
/>
</head><body>
<div
class=
"document"
>
<div
class=
"documentwrapper"
>
<div
class=
"bodywrapper"
>
<div
class=
"body"
role=
"main"
>
<section
class=
"tex2jax_ignore mathjax_ignore"
id=
"how-to-update-documentation"
>
<h1>
How to update documentation?
<a
class=
"headerlink"
href=
"#how-to-update-documentation"
title=
"Permalink to this headline"
>
¶
</a></h1>
<p>
Generate rst files from source code:
<br
/>
‘sphinx-apidoc -o . .. ‘
<em>
tests
</em>
’ ‘
<em>
migrations
</em>
’ ‘
</p>
<p>
Build HTML documentation from rst:
<br
/>
‘make html’
</p>
</section>
</div>
</div>
</div>
<div
class=
"sphinxsidebar"
role=
"navigation"
aria-label=
"main navigation"
>
<div
class=
"sphinxsidebarwrapper"
>
<h1
class=
"logo"
><a
href=
"index.html"
>
OACCT
</a></h1>
<h3>
Navigation
</h3>
<ul
class=
"current"
>
<li
class=
"toctree-l1"
><a
class=
"reference internal"
href=
"modules.html"
>
open-access-compliance-check-tool-oacct
</a></li>
<li
class=
"toctree-l1 current"
><a
class=
"current reference internal"
href=
"#"
>
How to update documentation?
</a></li>
</ul>
<div
class=
"relations"
>
<h3>
Related Topics
</h3>
<ul>
<li><a
href=
"index.html"
>
Documentation overview
</a><ul>
<li>
Previous:
<a
href=
"manage.html"
title=
"previous chapter"
>
manage module
</a></li>
</ul></li>
</ul>
</div>
<div
id=
"searchbox"
style=
"display: none"
role=
"search"
>
<h3
id=
"searchlabel"
>
Quick search
</h3>
<div
class=
"searchformwrapper"
>
<form
class=
"search"
action=
"search.html"
method=
"get"
>
<input
type=
"text"
name=
"q"
aria-labelledby=
"searchlabel"
autocomplete=
"off"
autocorrect=
"off"
autocapitalize=
"off"
spellcheck=
"false"
/>
<input
type=
"submit"
value=
"Go"
/>
</form>
</div>
</div>
<script>
$
(
'#searchbox'
).
show
(
0
);
</script>
</div>
</div>
<div
class=
"clearer"
></div>
</div>
<div
class=
"footer"
>
©
2021, EPFL + UNIGE.
|
Powered by
<a
href=
"http://sphinx-doc.org/"
>
Sphinx 4.1.2
</a>
&
<a
href=
"https://github.com/bitprophet/alabaster"
>
Alabaster 0.7.12
</a>
|
<a
href=
"_sources/sphinx_howto.txt"
rel=
"nofollow"
>
Page source
</a>
</div>
</body>
</html>
Event Timeline
Log In to Comment