8000 Fix headings, wording and numbered list in codespaces docs · matplotlib/matplotlib@8c3a9c0 · GitHub
[go: up one dir, main page]
Skip to content

Commit 8c3a9c0

Browse files
melissawmmarbled-toaststory645
committed
Fix headings, wording and numbered list in codespaces docs
Co-authored-by: marbled-toast <69227427+marbled-toast@users.noreply.github.com> Co-authored-by: hannah <story645@gmail.com>
1 parent 97c999c commit 8c3a9c0

File tree

2 files changed

+45
-41
lines changed

2 files changed

+45
-41
lines changed

‎doc/devel/codespaces.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Contributing to Matplotlib using GitHub codespaces
22

3-
For a general overview of contributing to Matplotlib, see https://matplotlib.org/devdocs/devel/index.html
3+
* < 10BC0 /span>For a general overview of contributing to Matplotlib, see https://matplotlib.org/devdocs/devel/index.html
44

5-
For instructions on how to submit Pull Requests using GitHub codespaces, see https://matplotlib.org/devdocs/devel/contribute.html#contributing-code
5+
* For instructions on how to submit Pull Requests using GitHub codespaces, see https://matplotlib.org/devdocs/devel/contribute.html#contributing-code
66

7-
For instructions on running tests to verify your changes, see https://matplotlib.org/devdocs/devel/testing.html
7+
* For instructions on running tests to verify your changes, see https://matplotlib.org/devdocs/devel/testing.html
88

9-
For instructions on building the Matplotlib documentation, see https://matplotlib.org/devdocs/devel/document.html#documenting-matplotlib
9+
* For instructions on building the Matplotlib documentation, see https://matplotlib.org/devdocs/devel/document.html#documenting-matplotlib

‎doc/devel/contribute.rst‎

Lines changed: 41 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -224,11 +224,11 @@ The preferred way to contribute to Matplotlib is to fork the `main
224224
repository <https://github.com/matplotlib/matplotlib/>`__ on GitHub,
225225
then submit a "pull request" (PR). You can do this by cloning a copy of the
226226
Maplotlib repository to your own computer, or alternatively using
227-
`GitHub Codespaces <https://docs.github.com/codespaces>`_ (a cloud-based
228-
in-browser development environment, that comes with the appropriated setup to
229-
contribute to Matplotlib).
227+
`GitHub Codespaces <https://docs.github.com/codespaces>`_, a cloud-based
228+
in-browser development environment that comes with the appropriated setup to
229+
contribute to Matplotlib.
230230

231-
A brief overview of the workflows is as follows.
231+
A brief overview of the workflow is as follows.
232232

233233
1. `Create an account <https://github.com/join>`_ on GitHub if you do not
234234
already have one.
@@ -247,22 +247,27 @@ A brief overview of the workflows is as follows.
247247

248248
.. tab-item:: Using GitHub Codespaces
249249

250-
3. Open codespaces on your fork by clicking on the green "Code" button
251-
on the GitHub web interface and selecting the "Codespaces" tab. Next,
252-
click on "Open codespaces on <your branch name>". You will be able to
253-
change branches later, so you can select the default ``main`` branch.
250+
3. Check out the Matplotlib repository and activate your development
251+
environment:
254252

255-
After the codespace is created, you will be taken to a new browser
256-
tab where you can use the terminal to activate a pre-defined conda
257-
environment called ``mpl-dev``::
253+
a. Open codespaces on your fork by clicking on the green "Code"
254+
button on the GitHub web interface and selecting the "Codespaces"
255+
tab. Next, click on "Open codespaces on <your branch name>". You
256+
will be able to change branches later, so you can select the
257+
default ``main`` branch.
258+
259+
b. After the codespace is created, you will be taken to a new browser
260+
tab where you can use the terminal to activate a pre-defined conda
261+
environment called ``mpl-dev``::
262+
263+
conda activate mpl-dev
258264

259-
conda activate mpl-dev
260265

261266
4. Install the local version of Matplotlib with::
262267

263268
python -m pip install -e .
264269

265-
(See :ref:`installing_for_devs` for detailed instructions.)
270+
See :ref:`installing_for_devs` for detailed instructions.
266271

267272
5. Create a branch to hold your changes::
268273

@@ -289,30 +294,29 @@ Finally, go to the web page of your fork of the Matplotlib repo, and click
289294
For more detailed instructions on how to set up Matplotlib for development and
290295
best practices for contribution, see :ref:`installing_for_devs`.
291296

292-
.. admonition:: GitHub Codespaces workflows
293-
294-
* If you need to open a GUI window with Matplotlib output on Codespaces, our
295-
configuration includes a `light-weight Fluxbox-based desktop
296-
<https://github.com/devcontainers/features/tree/main/src/desktop-lite>`_.
297-
You can use it by connecting to this desktop via your web browser. To do
298-
this:
299-
300-
1. Press ``F1`` or ``Ctrl/Cmd+Shift+P`` and select
301-
``Ports: Focus on Ports View`` in the VSCode session to bring it into
302-
focus. Open the ports view in your tool, select the ``noVNC`` port, and
303-
click the Globe icon.
304-
2. In the browser that appears, click the Connect button and enter the desktop
305-
password (``vscode`` by default).
306-
307-
Check the `GitHub instructions
308-
<https://github.com/devcontainers/features/tree/main/src/desktop-lite#connecting-to-the-desktop>`_
309-
for more details on connecting to the desktop.
310-
311-
* If you also built the documentation pages, you can view them using
312-
Codespaces. Use the "Extensions" icon in the activity bar to install the
313-
"Live Server" extension. Locate the ``doc/build/html`` folder in the
314-
Explorer, right click the file you want to open and select "Open with Live
315-
Server."
297+
GitHub Codespaces workflows
298+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
299+
300+
* If you need to open a GUI window with Matplotlib output on Codespaces, our
301+
configuration includes a `light-weight Fluxbox-based desktop
302+
<https://github.com/devcontainers/features/tree/main/src/desktop-lite>`_.
303+
You can use it by connecting to this desktop via your web browser. To do this:
304+
305+
1. Press ``F1`` or ``Ctrl/Cmd+Shift+P`` and select
306+
``Ports: Focus on Ports View`` in the VSCode session to bring it into
307+
focus. Open the ports view in your tool, select the ``noVNC`` port, and
308+
click the Globe icon.
309+
2. In the browser that appears, click the Connect button and enter the desktop
310+
password (``vscode`` by default).
311+
312+
Check the `GitHub instructions
313+
<https://github.com/devcontainers/features/tree/main/src/desktop-lite#connecting-to-the-desktop>`_
314+
for more details on connecting to the desktop.
315+
316+
* If you also built the documentation pages, you can view them using Codespaces.
317+
Use the "Extensions" icon in the activity bar to install the "Live Server"
318+
extension. Locate the ``doc/build/html`` folder in the Explorer, right click
319+
the file you want to open and select "Open with Live Server."
316320

317321
.. _contributing_documentation:
318322

0 commit comments

Comments
 (0)
0