How can I view doc changes locally? I've made some...
# announcements
k
How can I view doc changes locally? I've made some changes to
docs/sphinx/sections/api/apidocs/libraries/dagster_dask.rst
. And, following the directions at https://docs.dagster.io/community/contributing#developing-docs, I can run the docs website locally. But, when I navigate to the page, I see the original page without my local changes. I tried
make buildnext
, but it fails because there's no target named
buildnext
in the Makefile.
s
Hi @King Chung Huang.
make buildnext
should work inside the
docs/next
directory, if you haven't tried that yet
k
Hmm, no luck there either.
Copy code
root@6049974834d3:/project/docs/next# make buildnext
make: *** No rule to make target 'buildnext'.  Stop.
There's no Makefile in
docs/next
.
s
hmm this might have changed with the new docs website. @yuhan or @sashank would know best
a
I think the
README.md
in the docs folder is up to date
y
Hi! Make build will do it
s
Yup,
make build
in the
/docs
directory, then
make dev
to preview it
y
I’m afk. The docs/ README covers it
k
Cool, I'm trying that now. It didn't occur to me to look at the latest docs in the repo vs the docs site! 🙂
I'm not having any luck with
make build
in the
docs
directory. Getting an exception:
No module named 'sphinx_click'
.
Copy code
root@9aa182ca28e4:/project# cd docs
root@9aa182ca28e4:/project/docs# make build
cd sphinx; make clean; make json; cd ..; python pack_json.py
make[1]: Entering directory '/project/docs/sphinx'
rm -rf _build/*
make[1]: Leaving directory '/project/docs/sphinx'
make[1]: Entering directory '/project/docs/sphinx'
sphinx-build -b json -d _build/doctrees   . _build/json
Running Sphinx v3.5.2

Extension error:
Could not import extension sphinx_click.ext (exception: No module named 'sphinx_click')
make[1]: *** [Makefile:61: json] Error 2
make[1]: Leaving directory '/project/docs/sphinx'
Traceback (most recent call last):
  File "pack_json.py", line 111, in <module>
    main()
  File "pack_json.py", line 107, in main
    copy_searchindex(content_master_directory, json_directory)
  File "pack_json.py", line 91, in copy_searchindex
    write_json(os.path.join(src_dir, src_file), read_json(os.path.join(dest_dir, dest_file)))
  File "pack_json.py", line 10, in read_json
    with open(filename) as f:
FileNotFoundError: [Errno 2] No such file or directory: 'sphinx/_build/json/searchindex.json'
make: *** [Makefile:8: build] Error 1
p
You might need to
pip install docs-requirements.txt
from the root of the project
👍 1
k
Thanks, installing
docs-requirements.txt
was the missing key!