Skip to content

Commit 9e4bf7e

Browse files
datapythonistadatapythonista
authored
WEB: Deployment of development website with the docs (#28497)
1 parent 9d13c23 commit 9e4bf7e

File tree

7 files changed

+33
-22
lines changed

7 files changed

+33
-22
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Most development discussion is taking place on github in this repo. Further, the
225225

226226
All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.
227227

228-
A detailed overview on how to contribute can be found in the **[contributing guide](https://dev.pandas.io/contributing.html)**. There is also an [overview](.github/CONTRIBUTING.md) on GitHub.
228+
A detailed overview on how to contribute can be found in the **[contributing guide](https://dev.pandas.io/docs/contributing.html)**. There is also an [overview](.github/CONTRIBUTING.md) on GitHub.
229229

230230
If you are simply looking to start working with the pandas codebase, navigate to the [GitHub "issues" tab](https://github.com/pandas-dev/pandas/issues) and start looking through interesting issues. There are a number of issues listed under [Docs](https://github.com/pandas-dev/pandas/issues?labels=Docs&sort=updated&state=open) and [good first issue](https://github.com/pandas-dev/pandas/issues?labels=good+first+issue&sort=updated&state=open) where you could start out.
231231

‎azure-pipelines.yml

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ jobs:
104104
displayName: 'Running benchmarks'
105105
condition: true
106106
107-
- job: 'Docs'
107+
- job: 'Web_and_Docs'
108108
pool:
109109
vmImage: ubuntu-16.04
110110
timeoutInMinutes: 90
@@ -119,6 +119,11 @@ jobs:
119119
ci/setup_env.sh
120120
displayName: 'Setup environment and build pandas'
121121
122+
- script: |
123+
source activate pandas-dev
124+
python web/pandas_web.py web/pandas
125+
displayName: 'Build website'
126+
122127
- script: |
123128
source activate pandas-dev
124129
# Next we should simply have `doc/make.py --warnings-are-errors`, everything else is required because the ipython directive doesn't fail the build on errors (https://github.com/ipython/ipython/issues/11547)
@@ -128,15 +133,21 @@ jobs:
128133
displayName: 'Build documentation'
129134
130135
- script: |
131-
cd doc/build/html
136+
mkdir -p to_deploy/docs
137+
cp -r web/build/* to_deploy/
138+
cp -r doc/build/html/* to_deploy/docs/
139+
displayName: 'Merge website and docs'
140+
141+
- script: |
142+
cd to_deploy
132143
git init
133144
touch .nojekyll
134145
echo "dev.pandas.io" > CNAME
135146
printf "User-agent: *\nDisallow: /" > robots.txt
136147
git add --all .
137148
git config user.email "pandas-dev@python.org"
138-
git config user.name "pandas-docs-bot"
139-
git commit -m "pandas documentation in master"
149+
git config user.name "pandas-bot"
150+
git commit -m "pandas web and documentation in master"
140151
displayName: 'Create git repo for docs build'
141152
condition : |
142153
and(not(eq(variables['Build.Reason'], 'PullRequest')),
@@ -163,7 +174,7 @@ jobs:
163174
cd doc/build/html
164175
git remote add origin git@github.com:pandas-dev/pandas-dev.github.io.git
165176
git push -f origin master
166-
displayName: 'Publish docs to GitHub pages'
177+
displayName: 'Publish web and docs to GitHub pages'
167178
condition : |
168179
and(not(eq(variables['Build.Reason'], 'PullRequest')),
169180
eq(variables['Build.SourceBranch'], 'refs/heads/master'))

‎doc/source/whatsnew/v0.25.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -828,7 +828,7 @@ If installed, we now require:
828828
| pytest (dev) | 4.0.2 | |
829829
+-----------------+-----------------+----------+
830830
831-
For `optional libraries <https://dev.pandas.io/install.html#dependencies>`_ the general recommendation is to use the latest version.
831+
For `optional libraries <https://dev.pandas.io/docs/install.html#dependencies>`_ the general recommendation is to use the latest version.
832832
The following table lists the lowest version per library that is currently being tested throughout the development of pandas.
833833
Optional libraries below the lowest tested version may still work, but are not considered supported.
834834

‎web/pandas/config.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ navbar:
2626
- name: "Documentation"
2727
target:
2828
- name: "Getting started"
29-
target: https://pandas.pydata.org/pandas-docs/stable/getting_started/index.html
29+
target: /docs/getting_started/index.html
3030
- name: "User guide"
31-
target: https://pandas.pydata.org/pandas-docs/stable/user_guide/index.html
31+
target: /docs/user_guide/index.html
3232
- name: "API reference"
33-
target: https://pandas.pydata.org/pandas-docs/stable/reference/index.html
33+
target: /docs/reference/index.html
3434
- name: "Contributing to pandas"
35-
target: https://pandas.pydata.org/pandas-docs/stable/development/index.html
35+
target: /docs/development/index.html
3636
- name: "Release notes"
37-
target: https://pandas.pydata.org/pandas-docs/stable/whatsnew/index.html
37+
target: /docs/whatsnew/index.html
3838
- name: "Community"
3939
target:
4040
- name: "About pandas"

‎web/pandas/donate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ You can find more information about current developers and supporters in the [te
77
Financial contributions will mainly be used to advance in the [pandas roadmap](community/roadmap.html).
88

99
- If your **company or organization** is interested in helping make pandas better, please contact us at [info@numfocus.org](mailto:info@numfocus.org)
10-
- If you want to contribute to _pandas_ with your **time**, please visit the [contributing page](https://pandas.pydata.org/pandas-docs/stable/development/index.html)
10+
- If you want to contribute to _pandas_ with your **time**, please visit the [contributing page]({{ base_url }}/docs/development/index.html)
1111
- If you want to support _pandas_ with a **donation**, please use the form below:
1212

1313

‎web/pandas/index.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@ <h5>Getting started</h5>
2020
<ul>
2121
<!-- <li><a href="{{ base_url }}/try.html">Try pandas online</a></li> -->
2222
<li><a href="{{ base_url }}/install.html">Install pandas</a></li>
23-
<li><a href="https://pandas.pydata.org/pandas-docs/stable/getting_started/index.html">Getting started</a></li>
23+
<li><a href="{{ base_url }}/docs/getting_started/index.html">Getting started</a></li>
2424
</ul>
2525
</div>
2626
<div class="col-md-4">
2727
<h5>Documentation</h5>
2828
<ul>
29-
<li><a href="https://pandas.pydata.org/pandas-docs/stable/user_guide/index.html">User guide</a></li>
30-
<li><a href="https://pandas.pydata.org/pandas-docs/stable/reference/index.html">API reference</a></li>
31-
<li><a href="https://pandas.pydata.org/pandas-docs/stable/development/index.html">Contributing to pandas</a></li>
32-
<li><a href="https://pandas.pydata.org/pandas-docs/stable/whatsnew/index.html">Release notes</a></li>
29+
<li><a href="{{ base_url }}/docs/user_guide/index.html">User guide</a></li>
30+
<li><a href="{{ base_url }}/docs/reference/index.html">API reference</a></li>
31+
<li><a href="{{ base_url }}/docs/development/index.html">Contributing to pandas</a></li>
32+
<li><a href="{{ base_url }}/docs/whatsnew/index.html">Release notes</a></li>
3333
</ul>
3434
</div>
3535
<div class="col-md-4">
@@ -58,10 +58,10 @@ <h5>With the support of:</h5>
5858
{% if releases %}
5959
<h4>Latest version: {{ releases[0].name }}</h4>
6060
<ul>
61-
<li><a href="https://pandas.pydata.org/pandas-docs/stable/whatsnew/v0.25.0.html">What's new in {{ releases[0].name }}</a></li>
61+
<li><a href="docs/whatsnew/v0.25.0.html">What's new in {{ releases[0].name }}</a></li>
6262
<li>Release date:<br/>{{ releases[0].published.strftime("%b %d, %Y") }}</li>
63-
<li><a href="https://pandas.pydata.org/pandas-docs/stable/">Documentation (web)</a></li>
64-
<li><a href="https://pandas.pydata.org/pandas-docs/stable/pandas.pdf">Documentation (pdf)</a></li>
63+
<li><a href="{{ base_url}}/docs/">Documentation (web)</a></li>
64+
<li><a href="{{ base_url }}/docs/pandas.pdf">Documentation (pdf)</a></li>
6565
<li><a href="{{ releases[0].url }}">Download source code</a></li>
6666
</ul>
6767
{% endif %}

‎web/pandas/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The next steps provides the easiest and recommended way to set up your
44
environment to use pandas. Other installation options can be found in
5-
the [advanced installation page](https://pandas.pydata.org/pandas-docs/stable/install.html).
5+
the [advanced installation page]({{ base_url}}/docs/install.html).
66

77
1. Download [Anaconda](https://www.anaconda.com/distribution/) for your operating system and
88
the latest Python version, run the installer, and follow the steps. Detailed instructions

0 commit comments

Comments
 (0)