Skip to content

Commit 26c5e8c

Browse files
committed
Replace :ref: and :math: markup syntax
1 parent 2fcaf1e commit 26c5e8c

File tree

1 file changed

+25
-32
lines changed

1 file changed

+25
-32
lines changed

tutorials/UVES/UVES.ipynb

Lines changed: 25 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,8 @@
4646
"cell_type": "markdown",
4747
"metadata": {},
4848
"source": [
49-
"Please download this tar file <../downloads/astropy_UVES.tar.gz> and extract\n",
50-
"the content, either by clicking on the link or by executing this\n",
51-
"python code"
49+
"Please download the tar file and extract\n",
50+
"the content by executing this python code"
5251
]
5352
},
5453
{
@@ -132,8 +131,8 @@
132131
"metadata": {},
133132
"source": [
134133
"The previous astropy tutorial already covered\n",
135-
":ref:`handling-fits-files` and :ref:`wcs-transformations`, so the explanation here\n",
136-
"is only very brief. Check the `astropy documentation <http://docs.astropy.org>`_\n",
134+
"[handling FITS files](../FITS-header.html) and WCS transformations, so the explanation here\n",
135+
"is only very brief. Check the [astropy documentation](http://docs.astropy.org)\n",
137136
"or the other two tutorials for more details::"
138137
]
139138
},
@@ -276,8 +275,7 @@
276275
"with python (e.g. `glob`), external modules (e.g. `numpy` or `astropy`) and modules\n",
277276
"that you write yourself. The syntax to import those modules or functions\n",
278277
"is the same in all cases, provided that the directory where your module is\n",
279-
"defined is in the search path (`more about python modules and the search path\n",
280-
"<http://docs.python.org/2/tutorial/modules.html>`_)."
278+
"defined is in the search path [more about python modules and the search path](http://docs.python.org/2/tutorial/modules.html)."
281279
]
282280
},
283281
{
@@ -483,12 +481,12 @@
483481
"Often, one has to keep track of the units for certain values. Was the wavelength\n",
484482
"given in Angstrom or in nm? In X-ray observations, a common unit of wavelength is\n",
485483
"keV. How many nm is 0.65 keV?\n",
486-
"`astropy.units <http://docs.astropy.org/en/v0.2.1/units/index.html>`_\n",
484+
"[`astropy.units`](http://docs.astropy.org/en/v0.2.1/units/index.html)\n",
487485
"offers a framework that can take\n",
488486
"care of this book-keeping and propagate the units through many (but not all)\n",
489487
"mathematical operations (e.g. addition, division, multiplication).\n",
490488
"Furthermore,\n",
491-
"`astropy.constants <http://docs.astropy.org/en/v0.2.1/constants/index.html>`_ supplies the values of\n",
489+
"[`astropy.constants`](http://docs.astropy.org/en/v0.2.1/constants/index.html) supplies the values of\n",
492490
"many physical and astronomical constants.\n",
493491
"The easiest way to attach a unit to a number is by multiplication"
494492
]
@@ -534,12 +532,11 @@
534532
]
535533
},
536534
{
537-
"cell_type": "raw",
535+
"cell_type": "markdown",
538536
"metadata": {},
539537
"source": [
540-
"E_{kin} = E_{grav}\n",
541-
"\n",
542-
"\\frac{1}{2} m v^2 = G \\frac{m M_*}{R_*}"
538+
"$$E_{kin} = E_{grav}$$\n",
539+
"$$\\frac{1}{2} m v^2 = G \\frac{m M_*}{R_*}$$"
543540
]
544541
},
545542
{
@@ -614,10 +611,10 @@
614611
]
615612
},
616613
{
617-
"cell_type": "raw",
614+
"cell_type": "markdown",
618615
"metadata": {},
619616
"source": [
620-
"\\lambda_{heliocentric} = \\lambda_{bariocentric} * (1 + \\frac{v_{helio}}{c})"
617+
"$\\lambda_{heliocentric} = \\lambda_{bariocentric} * (1 + \\frac{v_{helio}}{c})$"
621618
]
622619
},
623620
{
@@ -665,7 +662,7 @@
665662
"metadata": {},
666663
"source": [
667664
"I want to mention one more feature here (check out\n",
668-
"`astropy.units <http://docs.astropy.org/en/v0.2.1/units/index.html>`_ for\n",
665+
"[`astropy.units`](http://docs.astropy.org/en/v0.2.1/units/index.html) for\n",
669666
"more): The ability to convert the spectral axis to frequencies or energies.\n",
670667
"Normally, a unit of length is not equivalent to a unit of energy or to a\n",
671668
"frequency, but this conversion makes sense for the wavelength of a spectrum.\n",
@@ -854,7 +851,7 @@
854851
"cell_type": "markdown",
855852
"metadata": {},
856853
"source": [
857-
"`astropy.time <http://docs.astropy.org/en/v0.2.1/time/index.html>`_\n",
854+
"[`astropy.time`](http://docs.astropy.org/en/v0.2.1/time/index.html\n",
858855
"provides methods to convert times and dates between different\n",
859856
"systems and formats. Since the ESO fits headers already contain the time of the\n",
860857
"observation in different systems, we could just read the keyword in the time\n",
@@ -1082,8 +1079,8 @@
10821079
"Now, we want to generate a LaTeX table of the observation times, period\n",
10831080
"and equivalent width that we can directly paste into our manuscript. To do so,\n",
10841081
"we first collect all the columns and make an ``astropy.table.Table`` object. (Please\n",
1085-
"check `astropy.table <http://docs.astropy.org/en/v0.2.1/table/index.html>`_\n",
1086-
"or :ref:`tabular-data` for more\n",
1082+
"check [`astropy.table`](http://docs.astropy.org/en/v0.2.1/table/index.html)\n",
1083+
"or `tabular-data` for more\n",
10871084
"details on ``Table``). So, here is the code"
10881085
]
10891086
},
@@ -1118,8 +1115,8 @@
11181115
"metadata": {},
11191116
"source": [
11201117
"We will make two plots. The plotting is done with\n",
1121-
"`matplotlib <http://matplotlib.org>`_, and does not involve Astropy itself.\n",
1122-
"Plotting is introduced in :ref:`plotting-and-images` and more details on\n",
1118+
"[`matplotlib`](http://matplotlib.org), and does not involve Astropy itself.\n",
1119+
"Plotting is introduced in `plotting-and-images` and more details on\n",
11231120
"plotting can be found there. When in doubt, use the search engine of your choice\n",
11241121
"and ask the internet. Here, I mainly want to illustrate that Astropy can be\n",
11251122
"used in real-live data analysis.\n",
@@ -1387,7 +1384,7 @@
13871384
"metadata": {},
13881385
"source": [
13891386
"Clearly, I did not develop this code for scratch.\n",
1390-
"The `matplotlib gallery <http://matplotlib.org/gallery.html>`_ is my\n",
1387+
"The [matplotlib gallery](http://matplotlib.org/gallery.html) is my\n",
13911388
"preferred place to look for plotting solutions."
13921389
]
13931390
},
@@ -1403,7 +1400,7 @@
14031400
"cell_type": "markdown",
14041401
"metadata": {},
14051402
"source": [
1406-
"`Astropy <http://astropy.org>`_ is an open-source and community-developed\n",
1403+
"[Astropy](http://astropy.org) is an open-source and community-developed\n",
14071404
"Python package, which means that is only as good as the contribution of the\n",
14081405
"astronomical community. Clearly, there will always people who have more fun writing\n",
14091406
"code and others who have more fun using it. However, if you find a bug and do not\n",
@@ -1412,15 +1409,12 @@
14121409
"request.\n",
14131410
"\n",
14141411
"If you want to get help or discuss issues with other Astropy users, you can\n",
1415-
"sign up for the `astropy mailing list\n",
1416-
"<http://mail.scipy.org/mailman/listinfo/astropy>`_.\n",
1417-
"Alternatively, the `astropy-dev\n",
1418-
"<http://groups.google.com/group/astropy-dev>`_ list is where you should go to\n",
1412+
"sign up for the [astropy mailing list](http://mail.scipy.org/mailman/listinfo/astropy).\n",
1413+
"Alternatively, the [astropy-dev](http://groups.google.com/group/astropy-dev) list is where you should go to\n",
14191414
"discuss more technical aspects of Astropy with the developers.\n",
14201415
"\n",
14211416
"If you have come across something that you believe is a bug, please open a\n",
1422-
"ticket in the Astropy `issue tracker\n",
1423-
"<http://github.com/astropy/astropy/issues>`_, and we will look into it\n",
1417+
"ticket in the Astropy [issue tracker](http://github.com/astropy/astropy/issues), and we will look into it\n",
14241418
"promptly.\n",
14251419
"\n",
14261420
"Please try to include an example that demonstrates the issue and will allow the\n",
@@ -1429,7 +1423,7 @@
14291423
"information about your operating system (e.g. MacOSX version or Linux version).\n",
14301424
"\n",
14311425
"Here is a practical example.\n",
1432-
":ref:`Above <formula-vaccr>` we calculated the free-fall\n",
1426+
"Above we calculated the free-fall\n",
14331427
"velocity onto MN Lup like this"
14341428
]
14351429
},
@@ -1466,8 +1460,7 @@
14661460
"source": [
14671461
"However, this raises a warning and automatically converts the quantity object\n",
14681462
"to an numpy array and the unit is lost. If you believe that is a bug that should\n",
1469-
"be fixed, you might chose to report it in the `issue tracker\n",
1470-
"<http://github.com/astropy/astropy/issues>`_.\n",
1463+
"be fixed, you might chose to report it in the [issue tracker](http://github.com/astropy/astropy/issues).\n",
14711464
"(But please check if somebody else has reported the same thing before, so we do\n",
14721465
"not clutter the issue tracker needlessly.)"
14731466
]

0 commit comments

Comments
 (0)