Skip to content

Commit c458e69

Browse files
authored
Merge pull request numpy#28941 from charris/fix-docs
DOC: Fix titles in ``development_ghcodespaces.rst``
2 parents 0317a81 + 25387ef commit c458e69

File tree

2 files changed

+33
-32
lines changed

2 files changed

+33
-32
lines changed

doc/source/dev/development_ghcodespaces.rst

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,31 @@ on your local machine or worry about configuration.
2121
What is a codespace?
2222
--------------------
2323

24-
A codespace is an instance of Codespaces - and thus a development
25-
environment that is hosted in the cloud. Each codespace runs on a virtual
26-
machine hosted by GitHub. You can choose the type of machine you want to use,
27-
depending on the resources you need. Various types of machine are available,
28-
starting with a 2-core processor, 4 GB of RAM, and 32 GB of storage.
29-
You can connect to a codespace from your browser, from Visual Studio Code,
30-
from the JetBrains Gateway application, or by using GitHub CLI.
24+
A codespace is an instance of Codespaces - and thus a development environment
25+
that is hosted in the cloud. Each codespace runs on a virtual machine hosted by
26+
GitHub. You can choose the type of machine you want to use, depending on the
27+
resources you need. Various types of machine are available, starting with a
28+
2-core processor, 4 GB of RAM, and 32 GB of storage. You can connect to a
29+
codespace from your browser, from Visual Studio Code, from the JetBrains
30+
Gateway application, or by using GitHub CLI.
3131

3232
Forking the NumPy repository
3333
----------------------------
3434

35-
The best way to work on the NumPy codebase as a contributor is by making a fork of the
36-
repository first.
35+
The best way to work on the NumPy codebase as a contributor is by making a fork
36+
of the repository first.
3737

3838
#. Browse to the `NumPy repository on GitHub`_ and `create your own fork`_.
3939
#. Browse to your fork. Your fork will have a URL like
4040
https://github.com/inessapawson/numpy, except with your GitHub username in place of ``inessapawson``.
4141

42-
Starting GitHub Codespaces - draft
42+
Starting GitHub Codespaces
4343
--------------------------
4444

45-
You can create a codespace from the green "Code" button (image to be added)
46-
on the repository home page, or click on this `open (image to be added)`_ button
45+
You can create a codespace from the green "<> Code" button on the repository
46+
home page and choose "Codespaces", or click this link `open`_.
4747

48-
Quick workspace tour - draft
48+
Quick workspace tour
4949
--------------------
5050

5151
You can develop code in a codespace using your choice of tool:
@@ -55,43 +55,43 @@ You can develop code in a codespace using your choice of tool:
5555
* the Visual Studio Code desktop application._
5656
* a browser-based version of Visual Studio Code._
5757

58-
In this quickstart, we will be using the VSCode desktop application as the editor.
59-
If you have not used it before, see the Getting started `VSCode docs`_ to familiarize
60-
yourself with this tool.
58+
In this quickstart, we will be using the VSCode desktop application as the
59+
editor. If you have not used it before, see the Getting started `VSCode docs`_
60+
to familiarize yourself with this tool.
6161

6262
Your workspace will look similar to the image below:
6363

6464
Development workflow with GitHub Codespaces
6565
-------------------------------------------
6666

67-
The :ref:`development-workflow` section of this documentation contains
68-
information regarding the NumPy development workflow. Make sure to check this
67+
The :ref:`development-workflow` section of this documentation contains
68+
information regarding the NumPy development workflow. Make sure to check this
6969
before you start working on your contributions.
7070

71-
Rendering the NumPy documentation - draft
71+
Rendering the NumPy documentation
7272
---------------------------------
7373

74-
You can find the detailed documentation on how the rendering of the documentation with
75-
Sphinx works in the :ref:`howto-build-docs` section.
74+
You can find the detailed documentation on how the rendering of the
75+
documentation with Sphinx works in the :ref:`howto-build-docs` section.
7676

77-
The documentation is pre-built during your codespace initialization. So once
78-
this task is completed, you have two main options to render the documentation
77+
The documentation is pre-built during your codespace initialization. So once
78+
this task is completed, you have two main options to render the documentation
7979
in GitHub Codespaces.
8080

8181
FAQs and troubleshooting
82-
-------------------------
82+
------------------------
8383

8484
**How long does my codespace stay active if I'm not using it?**
85-
If you leave your codespace running without interaction, or if you exit your
86-
codespace without explicitly stopping it, by default the codespace will timeout
87-
after 30 minutes of inactivity. You can customize the duration of the timeout period
88-
for new codespaces that you create.
85+
If you leave your codespace running without interaction, or if you exit your
86+
codespace without explicitly stopping it, by default the codespace will timeout
87+
after 30 minutes of inactivity. You can customize the duration of the timeout
88+
period for new codespaces that you create.
8989

9090
**Can I come back to a previous codespace?**
91-
The lifecycle of a codespace begins when you create a codespace and ends
92-
when you delete it. You can disconnect and reconnect to an active codespace without
93-
affecting its running processes. You may stop and restart a codespace without losing
94-
changes that you have made to your project.
91+
The lifecycle of a codespace begins when you create a codespace and ends when
92+
you delete it. You can disconnect and reconnect to an active codespace without
93+
affecting its running processes. You may stop and restart a codespace without
94+
losing changes that you have made to your project.
9595

9696
.. _GitHub Codespaces: https://github.com/features/codespaces
9797
.. _NumPy repository on GitHub: https://github.com/NumPy/NumPy

doc/source/dev/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,7 @@ The rest of the story
256256
howto_build_docs
257257
development_workflow
258258
development_advanced_debugging
259+
development_ghcodespaces
259260
reviewer_guidelines
260261
../benchmarking
261262
NumPy C style guide <https://numpy.org/neps/nep-0045-c_style_guide.html>

0 commit comments

Comments
 (0)