Skip to content

Commit

Permalink
Regression fix, improve doc
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
gastmaier committed Feb 26, 2024
1 parent cf53783 commit b88fa1d
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 12 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ Also extends Author Mode to watch changes on the webpage source code
Before getting started, install `npm`.
It is required due to the web scripts (`js modules`) and style sheets (`sass`).

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

### Why is the Python source code of this repo not watched?

Since a Python change would affect rebuilding the whole documentation,
those files are not watched by design.
Extensions at the doc itself are, however.

Alternatively, touch the source doc of the open page to rebuild only it
with the edited Python code.

## Removing

To remove, either release or development, do:
Expand Down
2 changes: 1 addition & 1 deletion adi_doctools/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from .directive import setup as directive_setup
from .role import setup as role_setup

__version__ = "0.3.14"
__version__ = "0.3.15"


def get_navigation_tree(app, context, pagename):
Expand Down
2 changes: 1 addition & 1 deletion adi_doctools/role/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
node = nodes.reference(rawtext, name, refuri=url, **options)
else:
text, path = get_outer_inner(text)
pos = path.find(':i')
pos = path.find(':')
if pos in [0, -1]:
branch = get_active_branch_name()
else:
Expand Down
2 changes: 1 addition & 1 deletion docs/ci.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ assets and licenses and generates the Python package.
Then, in the middle-stage, two parallel runs are launched:

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

Expand Down
10 changes: 10 additions & 0 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ For all options, do:
adoc author-mode --help
Why is the Python source code of this repo not watched?
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

Since a Python scripts change would affect rebuilding the whole documentation,
those files are not watched by design even with the ``--dev`` option.
Extensions at the doc itself are, however.

Alternatively, touch the source doc of the open page to rebuild only it
with the edited Python code.

Aggregate
--------------------------------------------------------------------------------

Expand Down

0 comments on commit b88fa1d

Please sign in to comment.