Skip to content

Commit b88fa1d

Browse files
committed
Regression fix, improve doc
On 4e1ae98 the `i` character was accidentally included to the find method, breaking the behaviour of the git role. Also, move doc info and add npm note to the README.md. Signed-off-by: Jorge Marques <jorge.marques@analog.com>
1 parent cf53783 commit b88fa1d

File tree

5 files changed

+17
-12
lines changed

5 files changed

+17
-12
lines changed

README.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ Also extends Author Mode to watch changes on the webpage source code
6161
Before getting started, install `npm`.
6262
It is required due to the web scripts (`js modules`) and style sheets (`sass`).
6363

64+
> **_NOTE:_** If the ``npm`` provided by your package manager is too old and
65+
> updating with `npm install npm -g` fails, consider installing with
66+
> [NodeSource](https://github.com/nodesource/distributions).
67+
6468
At this path, install the `npm` dependencies locally:
6569
```
6670
npm install rollup \
@@ -80,15 +84,6 @@ Finally, do a symbolic install of this repo:
8084
pip install -e . --upgrade
8185
```
8286

83-
### Why is the Python source code of this repo not watched?
84-
85-
Since a Python change would affect rebuilding the whole documentation,
86-
those files are not watched by design.
87-
Extensions at the doc itself are, however.
88-
89-
Alternatively, touch the source doc of the open page to rebuild only it
90-
with the edited Python code.
91-
9287
## Removing
9388

9489
To remove, either release or development, do:

adi_doctools/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
from .directive import setup as directive_setup
77
from .role import setup as role_setup
88

9-
__version__ = "0.3.14"
9+
__version__ = "0.3.15"
1010

1111

1212
def get_navigation_tree(app, context, pagename):

adi_doctools/role/common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
118118
node = nodes.reference(rawtext, name, refuri=url, **options)
119119
else:
120120
text, path = get_outer_inner(text)
121-
pos = path.find(':i')
121+
pos = path.find(':')
122122
if pos in [0, -1]:
123123
branch = get_active_branch_name()
124124
else:

docs/ci.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ assets and licenses and generates the Python package.
2121
Then, in the middle-stage, two parallel runs are launched:
2222

2323
* *Build Doc Latest*: uses the latest stable dependencies releases to
24-
generate this documentation, and store as an artifact..
24+
generate this documentation, and store as an artifact.
2525
* *Build Doc on Min*: uses the minimum requirements dependencies to generate
2626
this documentation, but the output is discarded.
2727

docs/cli.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,16 @@ For all options, do:
3636
3737
adoc author-mode --help
3838
39+
Why is the Python source code of this repo not watched?
40+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
41+
42+
Since a Python scripts change would affect rebuilding the whole documentation,
43+
those files are not watched by design even with the ``--dev`` option.
44+
Extensions at the doc itself are, however.
45+
46+
Alternatively, touch the source doc of the open page to rebuild only it
47+
with the edited Python code.
48+
3949
Aggregate
4050
--------------------------------------------------------------------------------
4151

0 commit comments

Comments
 (0)