Building this docs pageΒΆ

Sometimes when you modify the docs it’s convenient to generate them locally in order to check them before sending a pull request, to do so, you’ll have to install some extra dependencies:

Note

Remember that you’ll need a relatively newer version of setuptools and pip, so if you just created a virtualenv for the docs, you might have to run:

(inspirehep_docs)$ pip install --upgrade setuptools pip

Also keep in mind that you need all the inspire system dependecies installed too, if you don’t have them, go to Installation

(inspirehep_docs)$ pip install -e .[all]

And then, you can generate the html docs pages with:

(inspirehep_docs)$ make -C docs html

And to view them, you can just open them in your favourite browser:

(enspirehep_docs)$ firefox docs/_build/html/index.html