Skip to content

Commit b76094a

Browse files
committed
Merge branch 'master' into share-doctree-between-builders
2 parents bdb9c75 + a5616b9 commit b76094a

File tree

9 files changed

+45
-60
lines changed

9 files changed

+45
-60
lines changed

Diff for: docs/faq.rst

+3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ You can delete and re-create the project with the proper name to get a new slug,
2121
but you really shouldn't do this if you have existing inbound links,
2222
as it `breaks the internet <http://www.w3.org/Provider/Style/URI.html>`_.
2323

24+
If that isn't enough, you can ask to team to do this by `creating an issue <https://github.com/rtfd/readthedocs.org/issues/new>`__.
25+
26+
2427
How do I change the version slug of my project?
2528
-----------------------------------------------
2629

Diff for: docs/install.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ In order to get all the dependencies successfully installed,
3030
you need these libraries.
3131

3232
.. tabs::
33-
33+
3434
.. tab:: Mac OS
3535

3636
If you are having trouble on OS X Mavericks
3737
(or possibly other versions of OS X) with building ``lxml``,
3838
you probably might need to use Homebrew_ to ``brew install libxml2``,
3939
and invoke the install with::
40-
40+
4141
CFLAGS=-I/usr/local/opt/libxml2/include/libxml2 \
4242
LDFLAGS=-L/usr/local/opt/libxml2/lib \
4343
pip install -r requirements.txt
@@ -51,7 +51,7 @@ you need these libraries.
5151
sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev
5252

5353
If you don't have redis installed yet, you can do it with::
54-
54+
5555
sudo apt-get install redis-server
5656

5757
.. tab:: CentOS/RHEL 7
@@ -79,7 +79,7 @@ Get and run Read the Docs
7979

8080
Clone the repository somewhere on your disk and enter to the repository::
8181

82-
git clone https://github.com/rtfd/readthedocs.org.git
82+
git clone --recurse-submodules https://github.com/rtfd/readthedocs.org.git
8383
cd readthedocs.org
8484

8585
Create a virtual environment and activate it::
@@ -163,7 +163,7 @@ See our :doc:`/intro/import-guide` page to learn more.
163163
Further steps
164164
-------------
165165

166-
By now you can trigger builds on your local environment,
166+
By now you can trigger builds on your local environment,
167167
to encapsulate the build process inside a Docker container,
168168
see :doc:`development/buildenvironments`.
169169

Diff for: docs/versions.rst

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ This will point at the default branch for your VCS control: ``master``, ``defaul
99
We also create a ``stable`` version,
1010
if your project has any tagged releases.
1111
``stable`` will be automatically kept up to date to point at your highest version.
12+
If you want a custom ``stable`` version,
13+
create either a tag or branch in your project with that name.
1214

1315
How we envision versions working
1416
--------------------------------
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# -*- coding: utf-8 -*-
2+
# Generated by Django 1.11.20 on 2019-03-01 17:30
3+
from __future__ import unicode_literals
4+
5+
from django.db import migrations
6+
7+
8+
class Migration(migrations.Migration):
9+
10+
dependencies = [
11+
('core', '0005_migrate-old-passwords'),
12+
]
13+
14+
operations = [
15+
migrations.RemoveField(
16+
model_name='userprofile',
17+
name='allow_email',
18+
),
19+
]

Diff for: readthedocs/core/models.py

-21
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,6 @@ class UserProfile(models.Model):
3232
help_text=_('If unchecked, you will still see community ads.'),
3333
default=True,
3434
)
35-
allow_email = models.BooleanField(
36-
_('Allow email'),
37-
help_text=_('Show your email on VCS contributions.'),
38-
default=True,
39-
)
4035

4136
def __str__(self):
4237
return (
@@ -49,19 +44,3 @@ def get_absolute_url(self):
4944
'profiles_profile_detail',
5045
kwargs={'username': self.user.username},
5146
)
52-
53-
def get_contribution_details(self):
54-
"""
55-
Get the line to put into commits to attribute the author.
56-
57-
Returns a tuple (name, email)
58-
"""
59-
if self.user.first_name and self.user.last_name:
60-
name = '{} {}'.format(self.user.first_name, self.user.last_name)
61-
else:
62-
name = self.user.username
63-
if self.allow_email:
64-
email = self.user.email
65-
else:
66-
email = STANDARD_EMAIL
67-
return (name, email)

Diff for: readthedocs/restapi/urls.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
router.register(r'project', ProjectViewSet, basename='project')
3636
router.register(r'notification', NotificationViewSet, basename='emailhook')
3737
router.register(r'domain', DomainViewSet, basename='domain')
38-
router.register(r'sphinx_domains', SphinxDomainAPIView, base_name='sphinxdomain')
38+
router.register(r'sphinx_domains', SphinxDomainAPIView, basename='sphinxdomain')
3939
router.register(
4040
r'remote/org',
4141
RemoteOrganizationViewSet,

Diff for: readthedocs/sphinx_domains/api.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class SphinxDomainAPIView(UserSelectViewSet): # pylint: disable=too-many-ancest
3333
model = SphinxDomain
3434
serializer_class = SphinxDomainSerializer
3535
admin_serializer_class = SphinxDomainAdminSerializer
36-
filter_fields = (
36+
filterset_fields = (
3737
'project__slug',
3838
'version__slug',
3939
'domain',

Diff for: readthedocs/templates/core/project_list_detailed.html

+7-16
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,15 @@
2929
<span class="right-menu quiet">{% trans "No builds" %}</span>
3030
{% endif %}
3131

32-
{% if project.has_good_build %}
33-
<span class="dropdown" style="position:absolute; right:0px; top:0px;">
34-
<span>
35-
<a href="{{ project.get_docs_url }}">{% trans "View Docs" %}</a>
36-
<a href="#">&#x25BC;</a>
37-
</span>
38-
<ul>
39-
<li><input type="search" placeholder="{% trans "Search" %}&hellip;" /></li>
40-
{% for version in project.ordered_active_versions reversed %}
41-
<li><a href="{{ version.get_absolute_url }}">{{ version.slug }}</a></li>
42-
{% endfor %}
43-
</ul>
44-
</span>
45-
{% else %}
4632
<ul class="module-item-menu">
47-
<li><a href="{{ project.get_builds_url }}">{% trans "No Docs" %}</a></li>
33+
<li>
34+
{% if project.has_good_build %}
35+
<a href="{{ project.get_docs_url }}">{% trans "View Docs" %}</a>
36+
{% else %}
37+
<a href="{{ project.get_builds_url }}">{% trans "No Docs" %}</a>
38+
{% endif %}
39+
</li>
4840
</ul>
49-
{% endif %}
5041

5142

5243
</li>

Diff for: readthedocs/templates/core/project_list_featured.html

+7-16
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,15 @@
77
<a href="{{ user.get_absolute_url }}" class="quiet">({{ user }})</a>
88
{% endfor %}
99

10-
{% if project.has_good_build %}
11-
<span class="dropdown" style="position:absolute; right:0px; top:0px;">
12-
<span>
13-
<a href="{{ project.get_docs_url }}">{% trans "View Docs" %}</a>
14-
<a href="#">&#x25BC;</a>
15-
</span>
16-
<ul>
17-
<li><input type="search" placeholder="{% trans "Search" %}&hellip;" /></li>
18-
{% for version in project.ordered_active_versions reversed %}
19-
<li><a href="{{ version.get_absolute_url }}">{{ version.slug }}</a></li>
20-
{% endfor %}
21-
</ul>
22-
</span>
23-
{% else %}
2410
<ul class="module-item-menu">
25-
<li><a href="{{ project.get_builds_url }}">{% trans "No Docs" %}</a></li>
11+
<li>
12+
{% if project.has_good_build %}
13+
<a href="{{ project.get_docs_url }}">{% trans "View Docs" %}</a>
14+
{% else %}
15+
<a href="{{ project.get_builds_url }}">{% trans "No Docs" %}</a>
16+
{% endif %}
17+
</li>
2618
</ul>
27-
{% endif %}
2819

2920
</li>
3021

0 commit comments

Comments
 (0)