Skip to content

Docs update - #144

Merged
awni merged 1 commit into
ml-explore:mainfrom
noahsmartin:docsUpdate
Dec 12, 2023
Merged

awni merged 1 commit into
ml-explore:mainfrom
noahsmartin:docsUpdate

Conversation

@noahsmartin

Copy link
Copy Markdown
Contributor

Just fixes a small typo I noticed while reviewing the docs. I tried running Sphinx locally to verify the change but kept getting this error even without my change:

Running Sphinx v6.2.1
WARNING: The pre-Sphinx 1.0 'intersphinx_mapping' format is deprecated and will be removed in Sphinx 8. Update to the current format as described in the documentation. Hint: "intersphinx_mapping = {'<name>': ('https://docs.python.org/3', None)}".https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping
WARNING: The pre-Sphinx 1.0 'intersphinx_mapping' format is deprecated and will be removed in Sphinx 8. Update to the current format as described in the documentation. Hint: "intersphinx_mapping = {'<name>': ('https://numpy.org/doc/stable/', None)}".https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping
[autosummary] generating autosummary for: cpp/ops.rst, dev/extensions.rst, examples/linear_regression.rst, examples/llama-inference.rst, examples/mlp.rst, index.rst, install.rst, python/array.rst, python/data_types.rst, python/devices_and_streams.rst, ..., python/nn.rst, python/nn/module.rst, python/ops.rst, python/optimizers.rst, python/random.rst, python/transforms.rst, python/tree_utils.rst, quick_start.rst, unified_memory.rst, using_streams.rst

Extension error (sphinx.ext.autosummary):
Handler <function process_generate_options at 0x103abc550> for event 'builder-inited' threw an exception (exception: no module named mlx.core)
make: *** [html] Error 2

Seems like the change is small enough that not re-creating the html locally would be fine

@awni

awni commented Dec 12, 2023

Copy link
Copy Markdown
Member

FYI you need to install mlx to build the docs.

@awni awni left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

@awni
awni merged commit d14a0e4 into ml-explore:main Dec 12, 2023
@noahsmartin

Copy link
Copy Markdown
Contributor Author

Ah I had it installed in a different python env than I was using for the docs, thanks @awni !

JayYun98 pushed a commit to JayYun98/mlx that referenced this pull request Jan 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants