Browse Source

Fix issue #217 (GitHub)

* sphinx-doc/setup.rst: Fix missing quotes
Nicolas Petton 1 year ago
No known key found for this signature in database GPG Key ID: E8BCD7866AFCF978
2 changed files with 19 additions and 19 deletions
  1. +18
  2. +1

+ 18
- 18
doc/Indium.texi View File

@ -3,7 +3,7 @@
@documentencoding UTF-8
@*Generated by Sphinx 1.7.5.@*
@*Generated by Sphinx 1.8.4.@*
@end ifinfo
@settitle Indium Documentation
@defindex ge
@ -21,7 +21,7 @@
Indium 2.1.1, May 16, 2019
Indium 2.1.1, Sep 25, 2019
Nicolas Petton
@ -161,7 +161,7 @@ Troubleshooting
@end menu
@node Table of contents,Indices and tables,Top,Top
@anchor{index table-of-contents}@anchor{1}@anchor{index indium}@anchor{2}
@anchor{index indium}@anchor{1}@anchor{index table-of-contents}@anchor{2}
@chapter Table of contents
@ -177,7 +177,7 @@ Troubleshooting
@end menu
@node Installation,Getting up and running,,Table of contents
@anchor{installation installation}@anchor{3}@anchor{installation doc}@anchor{4}
@anchor{installation doc}@anchor{3}@anchor{installation installation}@anchor{4}
@section Installation
@ -206,7 +206,7 @@ Indium is availabe on MELPA@footnote{}, MELPA Stable@footnote{h
@end menu
@node The Indium server,Using MELPA,,Installation
@anchor{installation the-indium-server}@anchor{7}@anchor{installation server-installation}@anchor{8}
@anchor{installation server-installation}@anchor{7}@anchor{installation the-indium-server}@anchor{8}
@subsection The Indium server
@ -262,7 +262,7 @@ Add the following to your Emacs configuration:
@end example
@node Getting up and running,The REPL,Installation,Table of contents
@anchor{setup setup}@anchor{b}@anchor{setup doc}@anchor{c}@anchor{setup getting-up-and-running}@anchor{d}
@anchor{setup doc}@anchor{b}@anchor{setup getting-up-and-running}@anchor{c}@anchor{setup setup}@anchor{d}
@section Getting up and running
@ -356,7 +356,7 @@ Example configuration:
"name": "Web project",
"type": "chrome",
"host": "",
"url": "",
"port": 9222
@ -422,7 +422,7 @@ specified from the configurations in the @code{.indium.json} project file.
@end itemize
@node NodeJS requirements,Chrome/Chromium requirements,Starting Indium,Getting up and running
@anchor{setup nodejs-requirements}@anchor{6}@anchor{setup id3}@anchor{1a}
@anchor{setup id3}@anchor{1a}@anchor{setup nodejs-requirements}@anchor{6}
@subsection NodeJS requirements
@ -448,7 +448,7 @@ If you install NodeJS using @code{nvm}, chances are that Emacs won’t have it i
@code{exec path}. A simple solution is to use the excellent exec-path-from-shell@footnote{} package.
@node Chrome/Chromium requirements,,NodeJS requirements,Getting up and running
@anchor{setup chrome-requirements}@anchor{5}@anchor{setup chrome-chromium-requirements}@anchor{1b}
@anchor{setup chrome-chromium-requirements}@anchor{1b}@anchor{setup chrome-requirements}@anchor{5}
@subsection Chrome/Chromium requirements
@ -471,7 +471,7 @@ running, otherwise Chrome will simply open a new tab on the existing Chrome
instance, and the @code{remote-debugging-port} will not be set.
@node The REPL,Interaction in JS buffers,Getting up and running,Table of contents
@anchor{repl the-repl}@anchor{1c}@anchor{repl repl}@anchor{1d}@anchor{repl doc}@anchor{1e}
@anchor{repl doc}@anchor{1c}@anchor{repl repl}@anchor{1d}@anchor{repl the-repl}@anchor{1e}
@section The REPL
@ -488,7 +488,7 @@ instance, and the @code{remote-debugging-port} will not be set.
A REPL (Read Eval Print Loop) buffer is automatically open when a new Indium
connection is made (see @ref{b,,Getting up and running}).
connection is made (see @ref{d,,Getting up and running}).
@ -622,7 +622,7 @@ the current stack frame, and will be able to access local variables from the
stack, etc.
@node Interaction in JS buffers,The stepping debugger,The REPL,Table of contents
@anchor{code-evaluation interaction}@anchor{25}@anchor{code-evaluation doc}@anchor{26}@anchor{code-evaluation interaction-in-js-buffers}@anchor{27}
@anchor{code-evaluation doc}@anchor{25}@anchor{code-evaluation interaction}@anchor{26}@anchor{code-evaluation interaction-in-js-buffers}@anchor{27}
@section Interaction in JS buffers
@ -755,7 +755,7 @@ connection is made Indium will attempt to add back all breakpoints.
Since version 0.7, Indium uses sourcemap files by default.
For sourcemaps to work properly with Chrome/Chromium, make sure that a
workspace is correctly set (see @ref{b,,Getting up and running}).
workspace is correctly set (see @ref{d,,Getting up and running}).
@quotation Warning
@ -774,7 +774,7 @@ source-mapped. This can happen for instance when using Webpack.
@end menu
@node Overriding sourcemap paths,Overriding script paths,,Using sourcemaps
@anchor{debugger webpack}@anchor{2f}@anchor{debugger overriding-sourcemap-paths}@anchor{30}
@anchor{debugger overriding-sourcemap-paths}@anchor{2f}@anchor{debugger webpack}@anchor{30}
@subsubsection Overriding sourcemap paths
@ -804,7 +804,7 @@ sourcemap paths using @code{M-x indium-list-sourcemap-sources}.
@end cartouche
@node Overriding script paths,,Overriding sourcemap paths,Using sourcemaps
@anchor{debugger scriptpaths}@anchor{14}@anchor{debugger overriding-script-paths}@anchor{31}
@anchor{debugger overriding-script-paths}@anchor{31}@anchor{debugger scriptpaths}@anchor{14}
@subsubsection Overriding script paths
@ -838,13 +838,13 @@ expression of script paths to blackbox when debugging.
Blackboxed scripts are skipped when stepping in the debugger.
@node The inspector,Troubleshooting,The stepping debugger,Table of contents
@anchor{inspector the-inspector}@anchor{33}@anchor{inspector inspector}@anchor{20}@anchor{inspector doc}@anchor{34}
@anchor{inspector doc}@anchor{33}@anchor{inspector inspector}@anchor{20}@anchor{inspector the-inspector}@anchor{34}
@section The inspector
Indium features an object inspector that can be open on any object reference
from a REPL buffer (see @ref{1d,,The REPL}), the debugger (see @ref{2b,,The stepping debugger}), or
the result of any evaluation of JavaScript code (see @ref{25,,Interaction in JS buffers}).
the result of any evaluation of JavaScript code (see @ref{26,,Interaction in JS buffers}).
To inspect the result of the evaluation of an expression, press @code{C-c M-i}. An
inspector buffer will pop up. You can also press @code{RET} or left click on
@ -955,7 +955,7 @@ case an error happens in the server process.
First, make sure that @code{indium} is installed as documented in the
@ref{8,,The Indium server} section.
@ref{7,,The Indium server} section.
If you encounter the error:

+ 1
- 1
sphinx-doc/setup.rst View File

@ -71,7 +71,7 @@ Example configuration::
"name": "Web project",
"type": "chrome",
"host": "",
"url": "",
"port": 9222