spotentertainment.blogg.se - Jubler tutorial for mac

#Jubler tutorial for mac how to#
#Jubler tutorial for mac install#
#Jubler tutorial for mac mac#
#Jubler tutorial for mac windows#

#Jubler tutorial for mac windows#

Sphinx quickstart – contd.Ĭreate Windows command file? If you’re a Windows user, type y here, otherwise n. Sphinx is going to build all the documentation against the master document-so if you’d rather give it another name like ‘main’, you can change it here.ĭo you want to use the epub builder? Say no here (or enter).Īutodoc: automatically insert docstrings from modules: y (I answered yes here on advice from other documenters)įor the next few options ( doctest: through to githubpages:), I kept pressing Enter (or saying no) until I got toĬreate Makefile? Say yes here. Name of your master document: Press enter to accept the default value.

#Jubler tutorial for mac how to#

txt for a text file, but this tutorial is going to cover how to write in. (If you wanted to, you can change this to. Source file suffix : Press Enter to accept the default value (reStructuredText). Project language : Press Enter to accept the default English Project release/version: 1.0 (modify as necessary) Project name: Jubler (insert your own project name here) Name prefix for templates and static dir: You can leave as is and just press Enter (or change the prefix for the two mentioned directories if you want). Separate source and build directories: y (if your documentation is likely to be large, it’s better to say yes here) I’ve listed my answers in case you’re not sure how to proceed: You can answer the questions as per your own project’s requirements. To accept the default value (within square brackets), press Enter. You’ll be asked a bunch of questions now. With your virtual environment activated, run After creating a new directory, navigate to it in the command line.Ģ.

#Jubler tutorial for mac install#

To keep things organized, we’ll create a new directory called docs within our project/repository folder (that currently only has our virtual environment folder) and install Sphinx in there.

Whenever you want to deactivate and get out of your virtual environment, just run deactivate in the command line, and you will get out. If this is successful, you will now see (env) at the start of the terminal line. Replacing env with your virtual environment name. Activate the virtual environment: Any time you want to work on your project, you should activate the virtual environment by running In my case, a virtual environment named ‘ jublerenv‘ was created in my project directory.ĥ. If this ran successfully, you will notice a new folder within your project folder.

You can replace env with any name you want-this is the name of your virtual environment.

Remember to replace virtualenv with venv if you are using Python 3.

Replace python2 with whatever version of Python you have-my version is 2.7 (see image below).

Create a virtual environment: Navigate to the folder that was created when you cloned the repository: The preferred module for installing a virtual environment in this case is venv which will already be included in the standard library.ģ. If you’re using Python version 3.3 or newer, you can skip this step. Install virtualenv/ venv: The module for installing a virtual environment is virtualenv or venv for Python 3. If pip is not installed for you, this site might help.Ģ. Windows users can install Python from here.

#Jubler tutorial for mac mac#

If you’re using Mac or Linux, Python is most likely already installed. Open your command line app (I’m using Terminal in Mac) and make sure you have Python and pip 1 A tool for installing Python packages already installed.Git clone Clone the repo Installing a virtual environment Git clone and then paste the URL you just copied. (contd.) In the command line, navigate to where you want the repository folder to be, and run In the repository you just created, click the button to copy the repo’s URL.Ģ. Make a local clone of this repository.Create a Github account and a new repository that will hold your docs.If you’re working on someone else’s repository, follow this link to fork and clone the repository and keep your fork synced as well. The instructions below assume you’re getting the docs on to your own repository. This step will generate a project folder on the local drive so that we can proceed with installing a virtual environment and Sphinx. Creating and cloning a Github repository.In this part, we’re going to carry out the first three steps: In the Introduction to this tutorial, we went over what’s involved with documenting in Sphinx.