Skip to content
This repository was archived by the owner on Jun 7, 2023. It is now read-only.

Commit c369fde

Browse files
committed
change readme to rst
1 parent f80d30b commit c369fde

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

README.rst

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ The following three prerequisites are easily installed using pip. All are eithe
1515
3. Install paverutils
1616

1717

18+
First, get `Sphinx <http://sphinx.pocoo.org>`_, version 1.2.x is current as of this writing:
19+
1820
::
19-
First get `Sphinx <http://sphinx.pocoo.org>`_, version 1.1.x is current as of this writing:
2021

2122
# pip install sphinx
2223

@@ -54,26 +55,29 @@ Now from your browser you can open up http://localhost:8000/index.html
5455
Running your own web server isn't always the easiest way to go. So I have provided a couple of commands to make it easy for you to host your materials using githubs Pages feature.
5556

5657

57-
2. Create a repository (if you don't already have one where you would like to host the finished product) Copy the github URL to your clipboard.
58-
2. Type the command ``paver setup_github_pages`` You will be prompted to paste in the URL to your repository.
59-
2. Type the command ``paver deploy``
60-
2. Now you can access your pages from github at http://username.github.io/repo where username is your github username, and repo is the repository you created to host your deployed pages. Note that the deployed pages will be on the branch ``gh-pages``
58+
#. Create a repository (if you don't already have one where you would like to host the finished product) Copy the github URL to your clipboard.
59+
60+
#. Type the command ``paver setup_github_pages`` You will be prompted to paste in the URL to your repository.
61+
62+
#. Type the command ``paver deploy``
63+
64+
#. Now you can access your pages from github at http://username.github.io/repo where username is your github username, and repo is the repository you created to host your deployed pages. Note that the deployed pages will be on the branch ``gh-pages``
6165

6266
Details
6367
~~~~~~~
6468

6569
If you want to know the details of what goes on in the paver commands above here is what is happening:
6670

67-
3. paver build -- creates build directory and html files
68-
4. cd build
69-
5. git init
70-
5. git remote add origin [email protected]:bnmnetp/deploytest.git
71-
5. git checkout -b gh-pages
72-
5. git touch .nojekyll
73-
5. git add .nojekyll
74-
5. git add .
75-
6. git commit -m 'first published version'
76-
7. git push origin gh-pages
71+
#. paver build -- creates build directory and html files
72+
#. cd build
73+
#. git init
74+
#. git remote add origin [email protected]:bnmnetp/deploytest.git
75+
#. git checkout -b gh-pages
76+
#. git touch .nojekyll
77+
#. git add .nojekyll
78+
#. git add .
79+
#. git commit -m 'first published version'
80+
#. git push origin gh-pages
7781

7882
Now wait a few minutes and go to http://username.github.io/yourRepo
7983

0 commit comments

Comments
 (0)