Skip to content

Commit a1cabfd

Browse files
author
james
committed
docs: update read-me-project and change format
1 parent faf4727 commit a1cabfd

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

docs/ql-documentation/support/read-me-project.txt renamed to docs/ql-documentation/support/read-me-project.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,13 @@ Publishing this project for a new version
33

44
To update this project for a new version:
55

6-
#. Check with the language teams that all information in the ``ql/change-notes/support/`` directory is ready.
6+
1. Check with the language teams that all information in the ``ql/change-notes/support/`` directory is ready.
77

8-
#. Check that the versions of these files in the ``code`` repository match those in the ``ql`` repository.
9-
That is, there has been a "ql submodule bump" in the ``code`` repository since the last change to those files.
10-
11-
#. Open the ``global-conf.py`` file in the ``global-sphinx-files`` directory and change the following variables
8+
2. Open the ``global-conf.py`` file in the ``global-sphinx-files`` directory and change the following variables
129
to the correct value(s) if necessary:
1310

1411
* ``version =``
1512
* ``release = ``
1613
* If it's the first release of the year, ``copyright =``
1714

18-
#. Commit your changes. The output of the ``doc/sphinx`` PR check should be correct for the new version and ready to publish.
15+
3. Commit your changes. The output of the ``doc/sphinx`` PR check should be correct for the new version and ready to publish.

0 commit comments

Comments
 (0)