Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve developer's experience with docs #693

Merged
merged 3 commits into from
Jan 8, 2019
Merged

Improve developer's experience with docs #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd74550
Use virtualenvwrapper instead of plain virtualenv
abitrolly Jun 19, 2018
84c7812
Fix footer to point to GitHub and up year
abitrolly Jan 7, 2019
b66bcc9
Merge branch 'master' into 'workon'
Jan 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!--
Overriding Alabaster Theme to replace link to static page source
with a link to GitHub. Using instructions from official guide.

https://www.sphinx-doc.org/en/master/templating.html#jinja-sphinx-templating-primer
-->
{% extends "!layout.html" %}
{%- block footer %}
<div class="footer" style="text-align: center">
&copy;{{ copyright }}.|
Powered by <a href="http://sphinx-doc.org/">Sphinx {{ sphinx_version }}</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster {{ alabaster_version }}</a>
(<a href="https://github.com/release-monitoring/anitya/tree/master/docs/_templates">customized</a>)
|
<a href="https://github.com/release-monitoring/anitya/tree/master/docs/{{ pagename + ".rst"|e }}"
rel="nofollow">{{ _('View source') }}</a>
</div>
{%- endblock %}

2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@

# General information about the project.
project = 'Anitya'
copyright = '2016, Red Hat, Inc. and others'
copyright = '2019, Red Hat, Inc. and others'
author = 'Red Hat, Inc. and others'

# The version info for the project you're documenting, acts as replacement for
Expand Down
6 changes: 3 additions & 3 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,9 @@ Anitya can also be run in a Python virtualenv. For Fedora::

$ git clone https://github.com/release-monitoring/anitya.git
$ cd anitya
$ sudo dnf install python3-virtualenv
$ virtualenv-3 anitya-env
$ source anitya-env/bin/activate
$ sudo dnf install python3-virtualenvwrapper
$ mkvirtualenv anitya
$ workon anitya

Issuing that last command should change your prompt to indicate that you are
operating in an active virtualenv.
Expand Down