Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Open sidebar
ensembl-gh-mirror
ensembl-hive
Commits
1f9d1b03
Commit
1f9d1b03
authored
Aug 22, 2017
by
Matthieu Muffato
Browse files
Smaller requirements.txt since we rely on another file to setup sphinx as on RTD
parent
da678312
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
45 additions
and
3 deletions
+45
-3
docs/dev/build_the_docs.rst
docs/dev/build_the_docs.rst
+43
-0
docs/index.rst
docs/index.rst
+2
-0
requirements.txt
requirements.txt
+0
-3
No files found.
docs/dev/build_the_docs.rst
0 → 100644
View file @
1f9d1b03
Build the documentation locally
===============================
Python environment
------------------
The manual is written in RestructuredText_ and is built with Sphinx_. It
relies on a number of Python modules.
Locally, install these two requirements file:
* https://github.com/Ensembl/python-requirements/blob/master/readthedocs/requirements.txt
* https://github.com/Ensembl/ensembl-hive/blob/master/requirements.txt
On the EBI farm, those are already installed and you only need to activate
the `ehive_sphinx` environment with ``pyenv local ehive_sphinx``.
Other dependencies
------------------
* Doxygen_ to build the API documentation
* a checkout of the Ensembl `Core API`_, with ``PERL5LIB`` set, to enable
the Perl Doxygen filter
* Graphviz_ to generate the database diagrams
* Pandoc_ to convert the POD HTML to RestructuredText
Build process
-------------
Once you have all the above dependencies, go to ``ensembl-hive/docs``,
run ``make html`` and open ``_build/html/index.html``.
``make clean`` will cleanup all of ``_build/`` except the Doxygen
documentation, since it takes quite a lot of time to generate. Run ``make
cleaner`` to clean it up as well.
.. _RestructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://www.sphinx-doc.org/en/stable/
.. _Doxygen: http://www.stack.nl/~dimitri/doxygen/
.. _Graphviz: http://www.graphviz.org/
.. _Pandoc: https://pandoc.org/
.. _Core API: https://github.com/Ensembl/ensembl
docs/index.rst
View file @
1f9d1b03
...
...
@@ -91,8 +91,10 @@ Developer documentation
=======================
.. toctree::
:caption: Developer documentation
dev/release_checklist
dev/build_the_docs
Indices and tables
...
...
requirements.txt
View file @
1f9d1b03
sphinx-rtd-theme
sphinx
recommonmark
sphinxcontrib-doxylink
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