Skip to content

Commit 7b05cee

Browse files
ebezzamebezzam
committed
Update links to main repo.
1 parent e51dd62 commit 7b05cee

3 files changed

Lines changed: 17 additions & 17 deletions

File tree

‎README.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
python-dev-tips, `Slides <https://docs.google.com/presentation/d/1BnezhwUy22DiF72wss8GU_YIMfhjortz-uILdIFGuoM/edit?usp=sharing>`__
33
******************************************************************************************************************************************
44

5-
.. image:: https://readthedocs.org/projects/python-dev-tips/badge/?version=latest
6-
:target: http://python-dev-tips.readthedocs.io/en/latest/
5+
.. image:: https://readthedocs.org/projects/pydevtips/badge/?version=latest
6+
:target: http://pydevtips.readthedocs.io/en/latest/
77
:alt: Documentation Status
88

99

@@ -32,7 +32,7 @@ After installing Anaconda or `Miniconda <https://docs.conda.io/en/latest/minicon
3232
# activate environment
3333
conda activate project_env
3434
35-
# instal package locally
35+
# install package locally
3636
(project_env) pip install -e .
3737
3838
# deactivate environment
@@ -53,7 +53,7 @@ For machines really light on memory (e.g. Raspberry Pi) use
5353
# activate virtual environment
5454
source project_env/bin/activate
5555
56-
# instal package locally
56+
# install package locally
5757
(project_env) pip install -e .
5858
5959
# deactivate virtual environment

‎docs/source/badges.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ For example, in a `reStructuredText <https://www.sphinx-doc.org/en/master/usage/
77

88
.. code:: rst
99
10-
.. image:: https://readthedocs.org/projects/python-dev-tips/badge/?version=latest
11-
:target: http://python-dev-tips.readthedocs.io/en/latest/
10+
.. image:: https://readthedocs.org/projects/pydevtips/badge/?version=latest
11+
:target: http://pydevtips.readthedocs.io/en/latest/
1212
:alt: Documentation Status
1313
1414
which when rendered will make the following badge:
1515

16-
.. image:: https://readthedocs.org/projects/python-dev-tips/badge/?version=latest
17-
:target: http://python-dev-tips.readthedocs.io/en/latest/
16+
.. image:: https://readthedocs.org/projects/pydevtips/badge/?version=latest
17+
:target: http://pydevtips.readthedocs.io/en/latest/
1818
:alt: Documentation Status
1919

2020
You can also create `badges from GitHub Actions <https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge>`__.

‎docs/source/documentation.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ Adding new pages to your documentation amount to:
9292
#. Rebuilding the documentation, e.g. with ``make html``.
9393

9494
You may also need to edit the ``conf.py`` file to use different features.
95-
Check out our `index.rst <https://raw.githubusercontent.com/ebezzam/python-dev-tips/feat/docs/docs/source/index.rst>`__
96-
and `conf.py <https://github.com/ebezzam/python-dev-tips/blob/feat/docs/docs/source/conf.py>`__
95+
Check out our `index.rst <https://raw.githubusercontent.com/ebezzam/python-dev-tips/main/docs/source/index.rst>`__
96+
and `conf.py <https://github.com/ebezzam/python-dev-tips/blob/main/docs/source/conf.py>`__
9797
files for example configurations.
9898

9999

@@ -108,10 +108,10 @@ You can do a clean build of your documentation with the following commands:
108108
Pro-tips
109109
--------
110110

111-
* Changing to the ReadTheDocs theme inside `conf.py <https://github.com/ebezzam/python-dev-tips/blob/ec6b15c6718b96e2c1a00496d2cf7005755d006c/docs/source/conf.py#L75>`__.
111+
* Changing to the ReadTheDocs theme inside `conf.py <https://github.com/ebezzam/python-dev-tips/blob/e51dd62a2dd156fdd3e559be3930f87f2a4e6405/docs/source/conf.py#L75>`__.
112112
* `Intersphinx <https://docs.readthedocs.io/en/stable/guides/intersphinx.html>`__ for linking to other documentations.
113-
In the ``conf.py`` file: `add <https://github.com/ebezzam/python-dev-tips/blob/ec6b15c6718b96e2c1a00496d2cf7005755d006c/docs/source/conf.py#L43>`__
114-
the Sphinx extension, and `link <https://github.com/ebezzam/python-dev-tips/blob/ec6b15c6718b96e2c1a00496d2cf7005755d006c/docs/source/conf.py#L54>`__
113+
In the ``conf.py`` file: `add <https://github.com/ebezzam/python-dev-tips/blob/e51dd62a2dd156fdd3e559be3930f87f2a4e6405/docs/source/conf.py#L43>`__
114+
the Sphinx extension, and `link <https://github.com/ebezzam/python-dev-tips/blob/e51dd62a2dd156fdd3e559be3930f87f2a4e6405/docs/source/conf.py#L54>`__
115115
to the other documentation. Inside your documentation you can link to the other library, e.g.
116116
for data types:
117117

@@ -129,10 +129,10 @@ Pro-tips
129129
130130
which renders as in :func:`pydevtips.fftconvolve.RFFTConvolve.__init__`
131131
with a clickable link to NumPy's documentation.
132-
* `Mock modules <https://github.com/ebezzam/python-dev-tips/blob/ec6b15c6718b96e2c1a00496d2cf7005755d006c/docs/source/conf.py#L24>`__ to keep your documentation virtual environment light.
133-
* `Add the path <https://github.com/ebezzam/python-dev-tips/blob/feat/docs/docs/source/conf.py#L22>`__
132+
* `Mock modules <https://github.com/ebezzam/python-dev-tips/blob/e51dd62a2dd156fdd3e559be3930f87f2a4e6405/docs/source/conf.py#L24>`__ to keep your documentation virtual environment light.
133+
* `Add the path <https://github.com/ebezzam/python-dev-tips/blob/e51dd62a2dd156fdd3e559be3930f87f2a4e6405/docs/source/conf.py#L22>`__
134134
to your package, so that it doesn't have to be installed (again keeping your documentation environment light!).
135-
* `Automate year <https://github.com/ebezzam/python-dev-tips/blob/ec6b15c6718b96e2c1a00496d2cf7005755d006c/docs/source/conf.py#L32>`__.
135+
* `Automate year <https://github.com/ebezzam/python-dev-tips/blob/e51dd62a2dd156fdd3e559be3930f87f2a4e6405/docs/source/conf.py#L32>`__.
136136

137137

138138
Publishing
@@ -150,5 +150,5 @@ To publish on RTD:
150150
#. Import a project from the `dashboard <https://readthedocs.org/dashboard/>`__. There are two ways to do this: (1) linking your GitHub account and selecting one of your **public** repositories, or (2) importing the project manually. When linking to GitHub, the documentation is re-built whenever there are changes to the selected branch.
151151
#. Check your project page for the build status.
152152

153-
You can (optionally) define a `.readthedocs.yaml <https://github.com/ebezzam/python-dev-tips/blob/feat/docs/.readthedocs.yaml>`__
153+
You can (optionally) define a `.readthedocs.yaml <https://github.com/ebezzam/python-dev-tips/blob/main/.readthedocs.yaml>`__
154154
file to ensure a build environment as close as possible to your local machine.

0 commit comments

Comments
 (0)