Skip to content

Commit 98d47ec

Browse files
committed
Merge branch 'master' into fix-requirements-file-lookup
2 parents d482c89 + 64def2d commit 98d47ec

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+1755
-3121
lines changed

.eslintrc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
readthedocs-common/eslintrc
1+
common/eslintrc

.flake8

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
readthedocs-common/flake8
1+
common/flake8

.github/ISSUE_TEMPLATE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## Details
22

3-
* Project URL:
3+
* Read the Docs project URL:
44
* Build URL (if applicable):
5-
* Read the Docs username (if applicable):
5+
* Read the Docs username (if applicable):
66

77
## Expected Result
88

.gitmodules

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
[submodule "readthedocs-common"]
2-
path = readthedocs-common
3-
url = https://github.com/rtfd/readthedocs-common.git
1+
[submodule "common"]
2+
path = common
3+
url = https://github.com/rtfd/common.git

.isort.cfg

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
readthedocs-common/isort.cfg
1+
common/isort.cfg

.pep8

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
readthedocs-common/pep8
1+
common/pep8

.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
readthedocs-common/pre-commit-config.yaml
1+
common/pre-commit-config.yaml

.style.yapf

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
common/style.yapf

CHANGELOG.rst

+41
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,44 @@
1+
Version 2.3.6
2+
-------------
3+
4+
:Date: April 05, 2018
5+
6+
* `@agjohnson <http://github.com/agjohnson>`_: Drop readthedocs- prefix to submodule (`#3916 <https://github.com/rtfd/readthedocs.org/pull/3916>`_)
7+
* `@agjohnson <http://github.com/agjohnson>`_: This fixes two bugs apparent in nesting of translations in subprojects (`#3909 <https://github.com/rtfd/readthedocs.org/pull/3909>`_)
8+
* `@humitos <http://github.com/humitos>`_: Use new django celery beat scheduler (`#3908 <https://github.com/rtfd/readthedocs.org/pull/3908>`_)
9+
* `@humitos <http://github.com/humitos>`_: Use a proper default for `docker` attribute on UpdateDocsTask (`#3907 <https://github.com/rtfd/readthedocs.org/pull/3907>`_)
10+
* `@davidfischer <http://github.com/davidfischer>`_: Handle errors from publish_parts (`#3905 <https://github.com/rtfd/readthedocs.org/pull/3905>`_)
11+
* `@agjohnson <http://github.com/agjohnson>`_: Drop pdbpp from testing requirements (`#3904 <https://github.com/rtfd/readthedocs.org/pull/3904>`_)
12+
* `@stsewd <http://github.com/stsewd>`_: Little improve on sync_versions (`#3902 <https://github.com/rtfd/readthedocs.org/pull/3902>`_)
13+
* `@humitos <http://github.com/humitos>`_: Save Docker image data in JSON file only for DockerBuildEnvironment (`#3897 <https://github.com/rtfd/readthedocs.org/pull/3897>`_)
14+
* `@davidfischer <http://github.com/davidfischer>`_: Single analytics file for all builders (`#3896 <https://github.com/rtfd/readthedocs.org/pull/3896>`_)
15+
* `@humitos <http://github.com/humitos>`_: Organize logging levels (`#3893 <https://github.com/rtfd/readthedocs.org/pull/3893>`_)
16+
* `@agjohnson <http://github.com/agjohnson>`_: Add ref links for easier intersphinx on yaml config page (`#3877 <https://github.com/rtfd/readthedocs.org/pull/3877>`_)
17+
* `@stsewd <http://github.com/stsewd>`_: Pin astroid to fix linter issue on travis (`#3816 <https://github.com/rtfd/readthedocs.org/pull/3816>`_)
18+
* `@davidfischer <http://github.com/davidfischer>`_: Anonymize IP addresses for Google Analytics (`#3626 <https://github.com/rtfd/readthedocs.org/pull/3626>`_)
19+
20+
Version 2.3.5
21+
-------------
22+
23+
:Date: April 05, 2018
24+
25+
* `@agjohnson <http://github.com/agjohnson>`_: Drop pdbpp from testing requirements (`#3904 <https://github.com/rtfd/readthedocs.org/pull/3904>`_)
26+
* `@agjohnson <http://github.com/agjohnson>`_: Resolve subproject correctly in the case of single version (`#3901 <https://github.com/rtfd/readthedocs.org/pull/3901>`_)
27+
* `@davidfischer <http://github.com/davidfischer>`_: Fixed footer ads again (`#3895 <https://github.com/rtfd/readthedocs.org/pull/3895>`_)
28+
* `@davidfischer <http://github.com/davidfischer>`_: Fix an Alabaster ad positioning issue (`#3889 <https://github.com/rtfd/readthedocs.org/pull/3889>`_)
29+
* `@humitos <http://github.com/humitos>`_: Save Docker image hash in RTD environment.json file (`#3880 <https://github.com/rtfd/readthedocs.org/pull/3880>`_)
30+
* `@agjohnson <http://github.com/agjohnson>`_: Add ref links for easier intersphinx on yaml config page (`#3877 <https://github.com/rtfd/readthedocs.org/pull/3877>`_)
31+
* `@rajujha373 <http://github.com/rajujha373>`_: Typo correction in docs/features.rst (`#3872 <https://github.com/rtfd/readthedocs.org/pull/3872>`_)
32+
* `@gaborbernat <http://github.com/gaborbernat>`_: add description for tox tasks (`#3868 <https://github.com/rtfd/readthedocs.org/pull/3868>`_)
33+
* `@davidfischer <http://github.com/davidfischer>`_: Another CORS hotfix for the sustainability API (`#3862 <https://github.com/rtfd/readthedocs.org/pull/3862>`_)
34+
* `@agjohnson <http://github.com/agjohnson>`_: Fix up some of the logic around repo and submodule URLs (`#3860 <https://github.com/rtfd/readthedocs.org/pull/3860>`_)
35+
* `@davidfischer <http://github.com/davidfischer>`_: Fix linting errors in tests (`#3855 <https://github.com/rtfd/readthedocs.org/pull/3855>`_)
36+
* `@agjohnson <http://github.com/agjohnson>`_: Use gitpython to find a commit reference (`#3843 <https://github.com/rtfd/readthedocs.org/pull/3843>`_)
37+
* `@davidfischer <http://github.com/davidfischer>`_: Remove pinned CSS Select version (`#3813 <https://github.com/rtfd/readthedocs.org/pull/3813>`_)
38+
* `@davidfischer <http://github.com/davidfischer>`_: Use JSONP for sustainability API (`#3789 <https://github.com/rtfd/readthedocs.org/pull/3789>`_)
39+
* `@rajujha373 <http://github.com/rajujha373>`_: #3718: Added date to changelog (`#3788 <https://github.com/rtfd/readthedocs.org/pull/3788>`_)
40+
* `@xrmx <http://github.com/xrmx>`_: tests: mock test_conf_file_not_found filesystem access (`#3740 <https://github.com/rtfd/readthedocs.org/pull/3740>`_)
41+
142
.. _version-2.3.4:
243

344
Version 2.3.4

common

Submodule common added at 860a3eb

contrib/changelog.hbs

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{{header}}
22
{{toHeader header "-"}}
33

4+
:Date: {{date}}
5+
46
{{#issues}}* `@{{user.login}} <http://github.com/{{user.login}}>`_: {{title}} (`#{{number}} <{{html_url}}>`_)
57
{{/issues}}

docs/features.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ When you build your project on RTD, we automatically build a PDF of your project
6060
Search
6161
------
6262

63-
We provide full-text search across all of the pages of documentation hosted on our site. This uses the excellent Haystack project and Solr as the search backend. We hope to be integrating this into the site more fully in the future.
63+
We provide full-text search across all of the pages of documentation hosted on our site. This uses the excellent Haystack project and Elasticsearch as the search backend. We hope to be integrating this into the site more fully in the future.
6464

6565
Alternate Domains
6666
-----------------

docs/yaml-config.rst

+50-30
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ The file, ``readthedocs.yml`` (or ``.readthedocs.yml``), must be in the root dir
1010
Supported Settings
1111
------------------
1212

13+
.. _yaml__formats:
14+
1315
formats
1416
~~~~~~~
1517

@@ -35,6 +37,8 @@ Choose ``none`` to build none of the formats.
3537
- epub
3638
- pdf
3739
40+
.. _yaml__requirements_file:
41+
3842
requirements_file
3943
~~~~~~~~~~~~~~~~~
4044

@@ -48,6 +52,8 @@ The path to your Pip requirements file.
4852
requirements_file: requirements/docs.txt
4953
5054
55+
.. _yaml__conda:
56+
5157
conda
5258
~~~~~
5359

@@ -70,12 +76,14 @@ The file option specified the Conda `environment file`_ to use.
7076
.. note:: Conda is only supported via the YAML file.
7177

7278

79+
.. _yaml__build:
80+
7381
build
7482
~~~~~
7583

7684
The ``build`` block configures specific aspects of the documentation build.
7785

78-
.. _yaml_build_image:
86+
.. _yaml__build__image:
7987

8088
build.image
8189
```````````
@@ -103,12 +111,16 @@ as defined here:
103111
python:
104112
version: 3.6
105113
114+
.. _yaml__python:
115+
106116
python
107117
~~~~~~
108118

109119
The ``python`` block allows you to configure aspects of the Python executable
110120
used for building documentation.
111121

122+
.. _yaml__python__version:
123+
112124
python.version
113125
``````````````
114126

@@ -122,15 +134,17 @@ will be selected.
122134
.. warning::
123135

124136
The supported Python versions depends on the version of the build image your
125-
project is using. The default build image that is used to build documentation
126-
contains support for Python ``2.7`` and ``3.5``.
127-
See the :ref:`yaml_build_image` for more information on supported Python versions.
137+
project is using. The default build image that is used to build
138+
documentation contains support for Python ``2.7`` and ``3.5``. See the
139+
:ref:`yaml__build__image` for more information on supported Python versions.
128140

129141
.. code-block:: yaml
130142
131143
python:
132144
version: 3.5
133145
146+
.. _yaml__python__setup_py_install:
147+
134148
python.setup_py_install
135149
```````````````````````
136150

@@ -145,6 +159,8 @@ When true, install your project into the Virtualenv with
145159
python:
146160
setup_py_install: true
147161
162+
.. _yaml__python__pip_install:
163+
148164
python.pip_install
149165
``````````````````
150166

@@ -159,33 +175,37 @@ documentation.
159175
python:
160176
pip_install: true
161177
162-
.. To implement..
163-
164-
type
165-
~~~~
166-
167-
* Default: ``sphinx``
168-
* Options: ``sphinx``, ``mkdocs``
169-
170-
The ``type`` block allows you to configure the build tool used for building
171-
your documentation.
172-
173-
.. code-block:: yaml
174-
175-
type: sphinx
176-
177-
conf_file
178-
~~~~~~~~~
179-
180-
* Default: `None`
181-
* Type: Path (specified from the root of the project)
182-
183-
The path to a specific Sphinx ``conf.py`` file. If none is found, we will
184-
choose one.
185-
186-
.. code-block:: yaml
187178
188-
conf_file: project2/docs/conf.py
179+
.. TODO not yet implemented. We should move these to another doc.
180+
.. ==============================================================
181+
..
182+
.. type
183+
.. ~~~~
184+
..
185+
.. * Default: ``sphinx``
186+
.. * Options: ``sphinx``, ``mkdocs``
187+
..
188+
.. The ``type`` block allows you to configure the build tool used for building
189+
.. your documentation.
190+
..
191+
.. .. code-block:: yaml
192+
..
193+
.. type: sphinx
194+
..
195+
.. conf_file
196+
.. ~~~~~~~~~
197+
..
198+
.. * Default: `None`
199+
.. * Type: Path (specified from the root of the project)
200+
..
201+
.. The path to a specific Sphinx ``conf.py`` file. If none is found, we will
202+
.. choose one.
203+
..
204+
.. .. code-block:: yaml
205+
..
206+
.. conf_file: project2/docs/conf.py
207+
208+
.. _yaml__python__extra_requirements:
189209

190210
python.extra_requirements
191211
`````````````````````````

media/css/readthedocs-doc-embed.css

+45-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
/* Please keep RTD badge displayed on your site */
66
.rst-versions.rst-badge {
77
display: block;
8+
9+
bottom: 50px;
810
}
911

1012
.rst-other-versions {
@@ -60,7 +62,7 @@ div.ethical-sidebar, div.ethical-footer {
6062
padding-top: 1em;
6163
clear: both;
6264
}
63-
.ethical-sidebar .ethical-pixel, .ethical-footer .ethical-pixel {
65+
.ethical-sidebar .ethical-pixel, .ethical-footer .ethical-pixel, .ethical-fixedfooter .ethical-pixel {
6466
display: none !important;
6567
}
6668
.ethical-sidebar .ethical-text, .ethical-footer .ethical-text {
@@ -88,6 +90,41 @@ div.ethical-sidebar, div.ethical-footer {
8890
text-align: right;
8991
}
9092

93+
/* Fixed footer promotions */
94+
.ethical-fixedfooter {
95+
box-sizing: border-box;
96+
width: 100%;
97+
position: fixed;
98+
bottom: 0;
99+
left: 0;
100+
z-index: 100;
101+
background-color: #eee;
102+
border-top: 1px solid #bfbfbf;
103+
font-size: 12px;
104+
line-height: 16px;
105+
padding: 0.5em 2.5em;
106+
text-align: center;
107+
color: #404040;
108+
}
109+
.ethical-fixedfooter a,
110+
.ethical-fixedfooter a:hover,
111+
.ethical-fixedfooter a:active,
112+
.ethical-fixedfooter a:visited {
113+
color: #004B6B;
114+
text-decoration: underline;
115+
}
116+
.ethical-fixedfooter .ethical-close {
117+
position: absolute;
118+
top: 0;
119+
right: 5px;
120+
font-size: 15px;
121+
line-height: 15px;
122+
}
123+
.ethical-fixedfooter .ethical-close a {
124+
color: black;
125+
text-decoration: none;
126+
}
127+
91128
/* RTD Theme specific customizations */
92129
.ethical-rtd .ethical-sidebar {
93130
/* RTD theme doesn't set sidebar text color */
@@ -116,3 +153,10 @@ div.ethical-sidebar, div.ethical-footer {
116153
/* Alabaster needs some extra spacing before the footer ad */
117154
margin-top: 2em;
118155
}
156+
.ethical-alabaster::before {
157+
/* Alabaster's search box above the ad is floating */
158+
clear: both;
159+
content: '';
160+
display: table;
161+
margin-top: 3em;
162+
}
+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
// Google Analytics is a contentious issue inside Read the Docs and in our community.
2+
// Some users are very sensitive and privacy conscious to usage of GA.
3+
// Other users want their own GA tracker on their docs to see the usage their docs get.
4+
// The developers at Read the Docs understand that different users have different priorities
5+
// and we try to respect the different viewpoints as much as possible while also accomplishing
6+
// our own goals.
7+
8+
// Read the Docs largely funds our operations and development through advertising and
9+
// advertisers ask us questions that are easily answered with an analytics solution like
10+
// "how many users do you have in Switzerland browsing Python docs?". We need to be able
11+
// to easily get this data. We also use data from GA for some development decisions such
12+
// as what browsers to support (or not) or how much usage a particular page/feature gets.
13+
14+
// We have taken steps with GA to address some of the privacy issues.
15+
// Read the Docs instructs Google to anonymize IPs sent to them before they are stored (see below).
16+
17+
// We are always exploring our options with respect to analytics and if you would like
18+
// to discuss further, feel free to open an issue on github.
19+
20+
21+
// RTD Analytics Code
22+
23+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
24+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
25+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
26+
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
27+
28+
if (typeof READTHEDOCS_DATA !== 'undefined') {
29+
if (READTHEDOCS_DATA.global_analytics_code) {
30+
ga('create', READTHEDOCS_DATA.global_analytics_code, 'auto', 'rtfd');
31+
ga('rtfd.set', 'dimension1', READTHEDOCS_DATA.project);
32+
ga('rtfd.set', 'dimension2', READTHEDOCS_DATA.version);
33+
ga('rtfd.set', 'dimension3', READTHEDOCS_DATA.language);
34+
ga('rtfd.set', 'dimension4', READTHEDOCS_DATA.theme);
35+
ga('rtfd.set', 'dimension5', READTHEDOCS_DATA.programming_language);
36+
ga('rtfd.set', 'dimension6', READTHEDOCS_DATA.builder);
37+
ga('rtfd.set', 'anonymizeIp', true);
38+
ga('rtfd.send', 'pageview');
39+
}
40+
41+
// User Analytics Code
42+
if (READTHEDOCS_DATA.user_analytics_code) {
43+
ga('create', READTHEDOCS_DATA.user_analytics_code, 'auto', 'user');
44+
ga('user.set', 'anonymizeIp', true);
45+
ga('user.send', 'pageview');
46+
}
47+
// End User Analytics Code
48+
}
49+
50+
// end RTD Analytics Code

package.json

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"description": "Read the Docs build dependencies",
55
"author": "Anthony Johnson <[email protected]>",
66
"dependencies": {
7+
"bowser": "^1.9.3",
78
"cssfilter": "0.0.8",
89
"github-changelog": "git+https://github.com/agjohnson/github-changelog.git"
910
},

prospector.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
readthedocs-common/prospector.yml
1+
common/prospector.yml

0 commit comments

Comments
 (0)