@@ -30,8 +30,11 @@ improve the process:
30
30
Detailed installation instructions
31
31
----------------------------------
32
32
33
- Getting the Warehouse source code
34
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33
+ Get the Warehouse source code
34
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
35
+
36
+ First, fork and clone the Warehouse source code to work on it locally.
37
+
35
38
`Fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo >`_ the repository
36
39
on `GitHub `_ and
37
40
`clone <https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository >`_ it to
@@ -54,25 +57,36 @@ you stay up-to-date with our repository:
54
57
git merge upstream/main
55
58
56
59
57
- Configure the development environment
58
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
60
+ Create your development environment
61
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
59
62
60
63
.. note ::
61
- In case you are used to using a virtual environment for Python development:
62
- it's unnecessary for Warehouse development. Our Makefile scripts execute all
63
- developer actions inside Docker containers .
64
+ Warehouse development can be done using Makefile scripts which
65
+ execute all developer actions inside Docker containers. You do
66
+ not need to create a Python virtual environment .
64
67
65
- Verifying Make Installation
66
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
68
+ Verify that you have Make installed
69
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
67
70
68
- Verify that you have make installed in your environment
71
+ We use Make to build the docs and the Warehouse site.
72
+ Verify that you have Make installed in your environment.
69
73
70
74
.. code-block :: console
71
75
72
76
make --version
73
77
74
- If you do not have it installed,
75
- consult your OS documentation on how to install ``make ``.
78
+ If you do not have ``Make `` installed,
79
+ consult your operating system documentation on how to install ``make ``.
80
+
81
+
82
+ Do you want to build the docs or the Warehouse site?
83
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
84
+
85
+ If you wish to build the entire Warehouse site,
86
+ use Docker and follow the instructions below. However, if you are only
87
+ contributing to the user or development documentation, then you can skip
88
+ setting up Docker below and use ``Make `` instead. To build the docs,
89
+ follow the `instructions here <#build-docs >`_.
76
90
77
91
78
92
Why Docker?
@@ -733,13 +747,17 @@ formatting and linting. You can reformat with:
733
747
734
748
make reformat
735
749
750
+ .. _build-docs :
736
751
737
752
Building documentation
738
753
----------------------
739
754
740
755
The Warehouse documentation is stored in the :file: `docs/ `
741
- directory. It is written in `reStructured Text `_ and rendered using
742
- `Sphinx `_.
756
+ directory with three subdirectories: blog, dev and user.
757
+ Development docs (in the dev directory) are written in
758
+ `reStructured Text `_ and rendered using `Sphinx `_. User docs ``/user ``
759
+ are written in markdown and rendered using ``mkdocs ``. The blog is
760
+ also written in markdown.
743
761
744
762
Use :command: `make ` to build the documentation. For example:
745
763
0 commit comments