Skip to content
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.

Sign up for GitHub

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

rst format fix, ~~~ was being used instead of --- under subsections c… #939

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

rst format fix, ~~~ was being used instead of --- under subsections c… #939

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f485375
rst format fix, ~~~ was being used instead of --- under subsections c…
daniel-demelo Nov 25, 2018
62fa79d
image path fixed
daniel-demelo Nov 25, 2018
42846b0
headings fix and img path revert
daniel-demelo Nov 26, 2018
ac7ea52
autoenv hierarchy change / style applied to document
daniel-demelo Nov 27, 2018
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
10 changes: 5 additions & 5 deletions docs/dev/virtualenvs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Pipenv & Virtual Environments
=============================

.. image:: /_static/photos/35294660055_42c02b2316_k_d.jpg
.. image:: ../_static/photos/35294660055_42c02b2316_k_d.jpg
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this will break the image when deployed to python-guide.org.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

without it is broken for sure.
You can checkout the previous commit before I added this modification, the image does not appear at all.
Also, on GitHub help section about readme files (https://help.github.com/articles/about-readmes/) says:
"Relative links are easier for users who clone your repository. Absolute links may not work in clones of your repository - we recommend using relative links to refer to other files within your repository."
I am able to see everything at the moment on GitHub with the proper image rendered.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just built it locally with Sphinx and it worked fine.
No broken image.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So what I'm trying to say here is that the main target for this is the python-guide.org website, we've had this discussion on other PRs and for technical reasons we need the image URLs to stay the way they are until we revamp our deployment process for the website. Please remove the .. prefix, thanks!


This tutorial walks you through installing and using Python packages.

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

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

1. Create a virtual environment for a project:

Expand Down Expand Up @@ -285,7 +285,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 @@ -346,7 +346,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 +390,7 @@ can quickly switch between environments.
$ rmvirtualenv venv

Other useful commands
~~~~~~~~~~~~~~~~~~~~~
---------------------

``lsvirtualenv``
List all of the environments.
Expand Down