Skip to content

Commit d0fbb49

Browse files
committed
Merge branch 'main' of github.com:readthedocs/readthedocs.org into humitos/design-doc-future-builder
2 parents 3c83f44 + 2916317 commit d0fbb49

File tree

1,771 files changed

+33423
-13655
lines changed

Some content is hidden

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

1,771 files changed

+33423
-13655
lines changed

.circleci/config.yml

+22-4
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,40 @@
11
version: 2.1
22

3+
orbs:
4+
codecov: codecov/[email protected]
5+
36
jobs:
47
tests:
58
docker:
6-
- image: 'cimg/python:3.6'
9+
- image: 'cimg/python:3.10'
710
environment:
811
TOX_POSARGS: ''
9-
- image: 'docker.elastic.co/elasticsearch/elasticsearch:7.9.2'
12+
- image: 'docker.elastic.co/elasticsearch/elasticsearch:7.14.0'
1013
name: search
1114
environment:
1215
discovery.type: single-node
16+
ES_JAVA_OPTS: -Xms750m -Xmx750m
17+
steps:
18+
- checkout
19+
- run: git submodule sync
20+
- run: git submodule update --init
21+
- run: pip install --user tox
22+
- run: tox -e py310
23+
- codecov/upload
24+
25+
tests-embedapi:
26+
docker:
27+
- image: 'cimg/python:3.10'
1328
steps:
1429
- checkout
1530
- run: git submodule sync
1631
- run: git submodule update --init
1732
- run: pip install --user tox
18-
- run: tox -e py36,codecov
33+
- run: tox -c tox.embedapi.ini
1934

2035
checks:
2136
docker:
22-
- image: 'cimg/python:3.6'
37+
- image: 'cimg/python:3.10'
2338
environment:
2439
NODE_VERSION: 10.17.0
2540
steps:
@@ -34,9 +49,11 @@ jobs:
3449
echo 'export PATH=~/.nvm/versions/node/v${NODE_VERSION}/bin:$PATH' >> $BASH_ENV
3550
source $BASH_ENV
3651
- run: tox -e migrations
52+
- run: tox -e pre-commit
3753
- run: tox -e lint
3854
- run: tox -e docs-lint
3955
- run: tox -e docs
56+
- run: tox -e docs-dev
4057
- run: tox -e eslint
4158

4259
workflows:
@@ -45,3 +62,4 @@ workflows:
4562
jobs:
4663
- checks
4764
- tests
65+
- tests-embedapi

.codecov.yml

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
comment: off
22
coverage:
33
status:
4-
project: off
5-
patch: off
4+
project:
5+
default:
6+
informational: true
7+
patch:
8+
default:
9+
informational: true
10+
codecov:
11+
require_ci_to_pass: false
12+
github_checks:
13+
annotations: false

.github/CODEOWNERS

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
* @readthedocs/backend
2+
3+
/docs/ @readthedocs/advocacy

.github/ISSUE_TEMPLATE.md

-13
This file was deleted.

.github/ISSUE_TEMPLATE/bug.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Bug report
3+
about: Report some incorrect or unexpected behavior
4+
---
5+
6+
## Details
7+
8+
* Read the Docs project URL: https://readthedocs.org/projects/{your_project_slug}/
9+
* Build URL (if applicable): https://readthedocs.org/projects/{your_project_slug}/builds/{build_id}/
10+
* Read the Docs username (if applicable): https://readthedocs.org/profiles/{your_rtd_username}/
11+
12+
## Expected Result
13+
14+
*A description of what you wanted to happen*
15+
16+
## Actual Result
17+
18+
*A description of what actually happened*

.github/ISSUE_TEMPLATE/config.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
contact_links:
2+
- name: User support
3+
url: https://readthedocs.org/support/
4+
about: |
5+
If you need a specific request for your project or account,
6+
like more resources, a specific feature flag,
7+
change of the project slug or username, etc

.github/auto_assign.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# https://github.com/kentaro-m/auto-assign#assign-author-as-assignee
2+
# Set to author to set pr creator as assignee
3+
addAssignees: author

.github/workflows/main.yml

+4-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: CI
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77

88
jobs:
99
build:
@@ -15,6 +15,7 @@ jobs:
1515
run: |
1616
curl --request POST \
1717
--silent --output /dev/null \
18-
--url https://circleci.com/api/v1.1/project/github/${{ secrets.CORPORATE_REPO }}/tree/master \
18+
--url https://circleci.com/api/v2/project/gh/${{ secrets.CORPORATE_REPO }}/pipeline \
1919
--user '${{ secrets.CIRCLECI_USER_TOKEN }}:' \
20-
--data 'build_parameters[CIRCLE_JOB]=${{ secrets.CIRCLECI_JOB }}'
20+
--header 'content-type: application/json' \
21+
--data '{"branch": "main", "parameters":{"CIRCLE_JOB": "${{ secrets.CIRCLECI_JOB }}"}}'

.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
.cache
99
.coverage
1010
.coverage.*
11+
coverage.xml
1112
.idea
1213
.vagrant
1314
.vscode
@@ -54,6 +55,7 @@ private_*
5455
readthedocs/htmlcov
5556
tags
5657
.python-version
58+
.tool-versions
5759
*.pyo
5860
.pytest_cache/
5961
scripts/travis/elasticsearch*
@@ -66,6 +68,8 @@ venv/
6668
ENV/
6769
env.bak/
6870
venv.bak/
71+
.direnv/
72+
.envrc
6973

7074
dev.db-journal
7175
/readthedocs/settings/build_docker.py

.readthedocs.yml

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
version: 2
2+
23
formats: all
4+
35
sphinx:
46
configuration: docs/conf.py
7+
58
python:
69
install:
710
- requirements: requirements/pip.txt
811
- requirements: requirements/docs.txt
912

13+
build:
14+
os: ubuntu-20.04
15+
tools:
16+
python: "3.8"
17+
1018
search:
11-
ignore:
12-
# Internal documentation
13-
- development/design/*
14-
- search.html
15-
- 404.html
1619
ranking:
1720
# Deprecated content
1821
api/v1.html: -1
19-
config-file/v1.html: -1
22+
config-file/v1.html: -5
2023

2124
# Useful content, but not something we want most users finding
2225
changelog.html: -6

.style.yapf

-1
This file was deleted.

0 commit comments

Comments
 (0)