Skip to content

More h1 h2 fixes #945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions docs/dev/env.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
############################
Your Development Environment
============================
############################

.. image:: /_static/photos/33175624924_7febc46cc4_k_d.jpg


************
Text Editors
::::::::::::
************

Just about anything that can edit plain text will work for writing Python code,
however, using a more powerful editor may make your life a bit easier.
Expand Down Expand Up @@ -138,9 +140,9 @@ Recommended for Python development is
`Linter <https://github.com/AtomLinter/Linter>`_ combined with
`linter-flake8 <https://github.com/AtomLinter/linter-flake8>`_.


****
IDEs
::::
****

PyCharm / IntelliJ IDEA
-----------------------
Expand Down Expand Up @@ -231,9 +233,9 @@ based on the Qt gui toolkit, integrating the Scintilla editor control. Eric
is an open-source software project (GPLv3 licence) with more than ten years of
active development.


*****************
Interpreter Tools
:::::::::::::::::
*****************


Virtual Environments
Expand Down Expand Up @@ -269,8 +271,10 @@ the creation of different environments, and also makes it possible to use the
existing pyenv tools to switch to different environments based on environment
variables or ``.python-version`` files.


***********
Other Tools
:::::::::::
***********

IDLE
----
Expand Down
11 changes: 8 additions & 3 deletions docs/dev/pip-virtualenv.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
.. _pip-virtualenv:

###########################################
Further Configuration of Pip and Virtualenv
===========================================
###########################################

.. image:: /_static/photos/34018732105_f0e6758859_k_d.jpg


***************************************************
Requiring an active virtual environment for ``pip``
---------------------------------------------------
***************************************************

By now it should be clear that using virtual environments is a great way to
keep your development environment clean and keeping different projects'
Expand Down Expand Up @@ -87,8 +90,10 @@ install packages globally by running ``gpip install``. You can change the name
of the function to anything you like, just keep in mind that you will have to
use that name when trying to install packages globally with pip.


*******************************
Caching packages for future use
-------------------------------
*******************************

Every developer has preferred libraries and when you are working on a lot of
different projects, you are bound to have some overlap between the libraries
Expand Down
41 changes: 26 additions & 15 deletions docs/dev/virtualenvs.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
.. _virtualenvironments-ref:


#############################
Pipenv & Virtual Environments
=============================
#############################

.. image:: /_static/photos/35294660055_42c02b2316_k_d.jpg

Expand All @@ -18,9 +20,9 @@ managing development and testing environments for any kind of project.
.. Note:: This guide is written for Python 3, however, these instructions
should work fine on Python 2.7—if you are still using it, for some reason.


*********************************
Make sure you've got Python & pip
---------------------------------
*********************************

Before you go any further, make sure you have Python and that it's available
from your command line. You can check this by simply running:
Expand Down Expand Up @@ -64,9 +66,9 @@ using your OS package manager, you may have to `install pip <https://pip.pypa.io
.. _Homebrew: https://brew.sh
.. _Installing Python: https://docs.python-guide.org/starting/installation/


*****************
Installing Pipenv
-----------------
*****************

`Pipenv`_ is a dependency manager for Python projects. If you're familiar
with Node.js' `npm`_ or Ruby's `bundler`_, it is similar in spirit to those
Expand Down Expand Up @@ -109,8 +111,10 @@ Use ``pip`` to install Pipenv:
.. _modifying ~/.profile: https://stackoverflow.com/a/14638025
.. _Control Panel: https://msdn.microsoft.com/en-us/library/windows/desktop/bb776899(v=vs.85).aspx


************************************
Installing packages for your project
------------------------------------
************************************

Pipenv manages dependencies on a per-project basis. To install packages,
change into your project's directory (or just an empty directory for this
Expand Down Expand Up @@ -159,8 +163,9 @@ when you share your project with others. You should get output similar to this
.. _Requests: https://python-requests.org


************************
Using installed packages
------------------------
************************

Now that Requests is installed you can create a simple ``main.py`` file to
use it:
Expand Down Expand Up @@ -190,8 +195,9 @@ your script. It's also possible to spawn a new shell that ensures all commands
have access to your installed packages with ``$ pipenv shell``.


**********
Next steps
----------
**********

Congratulations, you now know how to install and use Python packages! ✨ 🍰 ✨

Expand Down Expand Up @@ -219,7 +225,7 @@ Test your installation
$ virtualenv --version

Basic Usage
~~~~~~~~~~~
-----------

1. Create a virtual environment for a project:

Expand Down Expand Up @@ -285,7 +291,7 @@ littered across your system, and its possible you'll forget their names or
where they were placed.

Other Notes
~~~~~~~~~~~
-----------

Running ``virtualenv`` with the option ``--no-site-packages`` will not
include the packages that are installed globally. This can be useful
Expand Down Expand Up @@ -318,8 +324,10 @@ control by adding it to the ignore list (see :ref:`Version Control Ignores<versi

.. _virtualenvwrapper-ref:


*****************
virtualenvwrapper
-----------------
*****************

`virtualenvwrapper <https://virtualenvwrapper.readthedocs.io/en/latest/index.html>`_
provides a set of commands which makes working with virtual environments much
Expand All @@ -346,7 +354,7 @@ To install (make sure **virtualenv** is already installed):
In Windows, the default path for WORKON_HOME is %USERPROFILE%\Envs

Basic Usage
~~~~~~~~~~~
===========

1. Create a virtual environment:

Expand Down Expand Up @@ -390,7 +398,7 @@ can quickly switch between environments.
$ rmvirtualenv venv

Other useful commands
~~~~~~~~~~~~~~~~~~~~~
=====================

``lsvirtualenv``
List all of the environments.
Expand All @@ -407,14 +415,17 @@ Other useful commands

`Full list of virtualenvwrapper commands <https://virtualenvwrapper.readthedocs.io/en/latest/command_ref.html>`_.


******************
virtualenv-burrito
------------------
******************

With `virtualenv-burrito <https://github.com/brainsik/virtualenv-burrito>`_, you
can have a working virtualenv + virtualenvwrapper environment in a single command.

*******
autoenv
-------
*******
When you ``cd`` into a directory containing a :file:`.env`, `autoenv <https://github.com/kennethreitz/autoenv>`_
automagically activates the environment.

Expand Down