diff --git a/README.md b/README.md index fcdbb39..ee4da87 100644 --- a/README.md +++ b/README.md @@ -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 \ @@ -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: diff --git a/adi_doctools/__init__.py b/adi_doctools/__init__.py index 728c85b..109c9fe 100644 --- a/adi_doctools/__init__.py +++ b/adi_doctools/__init__.py @@ -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): diff --git a/adi_doctools/role/common.py b/adi_doctools/role/common.py index 803161f..fe333d9 100644 --- a/adi_doctools/role/common.py +++ b/adi_doctools/role/common.py @@ -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: diff --git a/docs/ci.rst b/docs/ci.rst index 55459df..b6a14ba 100644 --- a/docs/ci.rst +++ b/docs/ci.rst @@ -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. diff --git a/docs/cli.rst b/docs/cli.rst index 27e4757..f21eb4c 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -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 --------------------------------------------------------------------------------