Skip to content

Commit 5f8b7a0

Browse files
committed
README.rst: Typos.
1 parent 7a2ca3b commit 5f8b7a0

File tree

1 file changed

+46
-46
lines changed

1 file changed

+46
-46
lines changed

README.rst

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Change to the root directory and run::
2929

3030
For convenience this package contains a [makefile](makefile) with this
3131
and other often used commands. Should you wish too, you can use the
32-
shorthand:
32+
shorthand::
3333

3434
$ make install
3535

@@ -77,7 +77,7 @@ configured in ``setup.py`` to run the tests::
7777

7878
This is just calling ``sage -t`` with appropriate flags.
7979

80-
Shorthand:
80+
Shorthand::
8181

8282
$ make test
8383

@@ -90,19 +90,19 @@ The documentation of the package can be generated using Sage's
9090
$ cd docs
9191
$ sage -sh -c "make html"
9292

93-
Shorthand:
93+
Shorthand::
9494

9595
$ make doc
9696

9797
For this to work on your own package, make sure you follow the same
9898
structure as we do here:
9999

100-
* Create a ``docs`` folder containing the exact same ``Makefile`` and a ``source``
101-
folder.
102-
* Copy and paste the ``docs/source/conf.py`` file from this package and update
103-
the few project specific variables at the beginning of the file.
104-
* Create an ``index.rst`` file as well as a ``<module name>.rst`` file for each
105-
module you want on the documentation.
100+
* Create a ``docs`` folder containing the exact same ``Makefile`` and a ``source``
101+
folder.
102+
* Copy and paste the ``docs/source/conf.py`` file from this package and update
103+
the few project specific variables at the beginning of the file.
104+
* Create an ``index.rst`` file as well as a ``<module name>.rst`` file for each
105+
module you want on the documentation.
106106

107107
Travis CI integration
108108
---------------------
@@ -124,14 +124,14 @@ versions used.
124124
Automatically deploying documentation to GitHub pages using Travis CI
125125
---------------------------------------------------------------------
126126

127-
* First do the steps described above to enable Travis CI integration
128-
of your GitHub-hosted project.
129-
130-
* If you don't already have GitHub pages for your project: Create and
131-
checkout a branch ``gh-pages`` in your repository and put an empty
132-
file ``.nojekyll`` in it. (See
133-
https://help.github.com/articles/files-that-start-with-an-underscore-are-missing/)::
134-
Commit it and push it to GitHub::
127+
* First do the steps described above to enable Travis CI integration
128+
of your GitHub-hosted project.
129+
130+
* If you don't already have GitHub pages for your project: Create and
131+
checkout a branch ``gh-pages`` in your repository and put an empty
132+
file ``.nojekyll`` in it (see
133+
https://help.github.com/articles/files-that-start-with-an-underscore-are-missing/).
134+
Then commit it and push it to GitHub::
135135

136136
$ git clone --single-branch --depth 1 https://github.com/USER/PROJECT.git gh-pages
137137
$ cd gh-pages
@@ -142,58 +142,58 @@ Automatically deploying documentation to GitHub pages using Travis CI
142142
$ git commit -m "Initial commit"
143143
$ git push -u origin gh-pages
144144
$ cd ..
145-
146-
* (Back in your working copy:) Generate a new ssh key pair with an
147-
empty passphrase::
145+
146+
* (Back in your working copy:) Generate a new ssh key pair with an
147+
empty passphrase::
148148

149149
$ ssh-keygen -t dsa -f .travis_ci_gh_pages_deploy_key
150150

151-
* Add the public ssh key (contents of the file
152-
``.travis_ci_gh_pages_deploy_key.pub``) to your GitHub repository
153-
as a deploy key (Settings/Deploy keys/Add deploy key).
154-
Title: Key for deploying documentation to GitHub pages.
155-
Check Allow write access.
151+
* Add the public ssh key (contents of the file
152+
``.travis_ci_gh_pages_deploy_key.pub``) to your GitHub repository
153+
as a deploy key (Settings/Deploy keys/Add deploy key).
154+
Title: Key for deploying documentation to GitHub pages.
155+
Check Allow write access.
156156

157-
* Install the Travis CI command-line client from
158-
https://github.com/travis-ci/travis.rb::
157+
* Install the Travis CI command-line client from
158+
https://github.com/travis-ci/travis.rb::
159159

160160
$ gem install travis
161-
162-
* Log in to Travis CI using your GitHub credentials::
161+
162+
* Log in to Travis CI using your GitHub credentials::
163163

164164
$ travis login
165-
166-
* Encrypt the private ssh key, add the decryption keys
167-
as secure environment variables to Travis CI, and
168-
add code to ``.travis.yml`` to decrypt it::
165+
166+
* Encrypt the private ssh key, add the decryption keys
167+
as secure environment variables to Travis CI, and
168+
add code to ``.travis.yml`` to decrypt it::
169169

170170
$ travis encrypt-file .travis_ci_gh_pages_deploy_key --add before_script
171171

172-
* Add the encrypted private ssh key to the repository::
172+
* Add the encrypted private ssh key to the repository::
173173

174174
$ git add .travis_ci_gh_pages_deploy_key.enc
175175

176-
* Have git ignore the other keys (and the gh-pages directory)::
176+
* Have git ignore the other keys (and the gh-pages directory)::
177177

178178
$ echo >> .gitignore
179179
$ echo "/.travis_ci_gh_pages_deploy_key" >> .gitignore
180180
$ echo "/.travis_ci_gh_pages_deploy_key.pub" >> .gitignore
181181
$ echo "/gh-pages" >> .gitignore
182182
$ git add .gitignore
183183

184-
* Optionally, edit ``.travis.yml`` to adjust variables ``DEPLOY_DOC_...``
184+
* Optionally, edit ``.travis.yml`` to adjust variables ``DEPLOY_DOC_...``
185185

186-
* Commit all changes to GitHub. The Travis CI build should then run
187-
automatically and deploy it::
186+
* Commit all changes to GitHub. The Travis CI build should then run
187+
automatically and deploy it::
188188

189189
$ git add .travis.yml
190190
$ git commit -m "Deploy built documentation to GitHub"
191191
$ git push
192-
193-
* The deployed documentation will be available at:
194-
https://USER.github.io/PROJECT/
195-
This can be customized by changing ``DEPLOY_DOC_TO_DIRECTORY=/``
196-
to another directory in ``.travis.yml``
197-
For example, setting ``DEPLOY_DOC_TO_DIRECTORY=doc/html`` will make
198-
the deployed documentation available at:
199-
https://USER.github.io/PROJECT/doc/html/
192+
193+
* The deployed documentation will be available at:
194+
https://USER.github.io/PROJECT/
195+
This can be customized by changing ``DEPLOY_DOC_TO_DIRECTORY=/``
196+
to another directory in ``.travis.yml``
197+
For example, setting ``DEPLOY_DOC_TO_DIRECTORY=doc/html`` will make
198+
the deployed documentation available at:
199+
https://USER.github.io/PROJECT/doc/html/

0 commit comments

Comments
 (0)