Add build instructions to the README

[ddbeck]

Currently, building and viewing the guide locally is undocumented. The README file would probably be a good place to add this information. This issue would be an excellent task for a first-time contributor with basic familiarity with the command line and installing things with pip.

Here are the rough steps to complete this task:

1. Fork this repository.

2. In your fork, edit README.rst (the file uses reStructuredText markup which is similar to Markdown; see this reStructuredText reference for help).

   Add a new section heading ("How to build this guide", perhaps) and step-by-step instructions. Here's how you build the docs:

   • Sphinx is required to build the docs. You can install it with pip install Sphinx.
   • The build command is make html (or on Windows make.bat html).

   Once you've built the guide, you can open build/html/index.html in a web browser to see the guide. You should try following your instructions to make sure they work before opening a pull request.

3. Commit your changes and push to your fork.

4. Open a pull request and mention this issue.

That's it! Please comment if you need any help. Thanks!

(And if you like this, check out issue #194 where there's lots more to help out with!)

[souravsingh]

I will be working on this.

[souravsingh]

I have added the instructions in my fork of the project.They can be accessed here at souravsingh@e8177c9

[ddbeck]

@souravsingh I was hoping that this issue would present an opportunity for someone who has not yet contributed to do so, since some volunteers indicated that they were new to GitHub and Python (plus, it's not germane to your existing pull request, complicating the review process). Would you be willing to hold off submitting this for a while, to give a first timer a chance to attempt it?

[souravsingh]

@ddbeck I made a mistake of editing the README within the develop branch and I am really sorry about it. As for the issue, I didn't know that the issue was for Python newbies.So I am willing to hold off on it.

[souravsingh]

@ddbeck Would it be good if we can add a tag to some of the issues saying something like "low-hanging-fruit" or "newbie-friendly" to bring newbies into making their first PR?

[ddbeck]

@souravsingh That's an excellent idea! I ought to tag all the new tutorials stuff too. I'll do that this evening.

[MenukaIshan]

Hello @ddbeck I'm New new to GitHub and Python. Is this opportunity still available? I would love to learn and contribute.

[theacodes]

@Menuka5 yep! This is still available. However, @ddbeck's instructions only need to be tweaked slighty:

1. Nox is required to build the guide locally. You can install Nox using pip install nox-automation.
2. To build the docs, run nox -s build. You can build the docs and start a local web server to preview the docs by running nox -s preview.

[ddbeck]

Hi @Menuka5, thanks for taking an interest in this issue! @jonparrott is right about those changes. If you need any help with making the pull request, feel free to ask questions here, and I'll do what I can.

[MenukaIshan]

Thank you @ddbeck and @jonparrott I forked the repository and currently learning ReStructuredText for documentation. I may need a help since I haven't done any pull request before :)

[MenukaIshan]

Hi @ddbeck and @jonparrott I completed the task https://github.com/Menuka5/python-packaging-user-guide Your feedback is highly appreciated