Skip to content

Commit

Permalink
doc: fix installation guide, add doc build info part 2
Browse files Browse the repository at this point in the history
  • Loading branch information
mutantsan committed Dec 3, 2024
1 parent 31a2fae commit d4a4d5b
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,15 @@ We are using `mkdocs` to build the documentation. To build and deploy the docume
We need to set the `CHARTS_FIELDS` for our custom handler, that autogenerate documentation
for chart types fields.

The CKAN instance will be initialized, because we will call validators and helpers in this code. Therefore, you'll need
another environment variable to set the CKAN configuration file path:

export CKAN_INI=$PWD/config/ckan.ini

The config file must enable the `ckanext-charts` plugin:

ckan.plugins = ... charts_view charts_builder_view ...

If you're working on the documentation, you can run the following command to start a live-reloading server without
gathering the chart types fields data. It will speed up the process significantly, as we won't need to wait for the
CKAN initialization:
Expand Down
7 changes: 7 additions & 0 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1066,6 +1066,13 @@ <h2 id="building-the-documentation">Building the documentation</h2>
</code></pre>
<p>We need to set the <code>CHARTS_FIELDS</code> for our custom handler, that autogenerate documentation
for chart types fields.</p>
<p>The CKAN instance will be initialized, because we will call validators and helpers in this code. Therefore, you'll need
another environment variable to set the CKAN configuration file path:</p>
<pre><code>export CKAN_INI=$PWD/config/ckan.ini
</code></pre>
<p>The config file must enable the <code>ckanext-charts</code> plugin:</p>
<pre><code>ckan.plugins = ... charts_view charts_builder_view ...
</code></pre>
<p>If you're working on the documentation, you can run the following command to start a live-reloading server without
gathering the chart types fields data. It will speed up the process significantly, as we won't need to wait for the
CKAN initialization:</p>
Expand Down
2 changes: 1 addition & 1 deletion site/search/search_index.json

Large diffs are not rendered by default.

0 comments on commit d4a4d5b

Please sign in to comment.