Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: swap sol macro doctests symlink #657

Merged
merged 1 commit into from
Jun 11, 2024
Merged

Conversation

DaniPopes
Copy link
Member

@DaniPopes DaniPopes commented Jun 11, 2024

Before: sol-macro/doctests/ was a symlink to sol-types/tests/doctests/
After: sol-types/tests/doctests/ is a symlink to sol-macro/doctests/

We can also remove the cfg_attr(doc, doc = include...) in the sol! docs since the files are always present

I initially did this the other way around because rust-analyzer does not consider the files as in the workspace, and so are completely disabled. However I did not realize this means documentation cannot be built locally

Fixes #656

@onbjerg onbjerg added bug Something isn't working documentation Improvements or additions to documentation and removed bug Something isn't working labels Jun 11, 2024
@DaniPopes DaniPopes merged commit 3b973cc into main Jun 11, 2024
30 checks passed
@DaniPopes DaniPopes deleted the dani/swap-doctest-symlink branch June 11, 2024 06:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] Regression: code examples are missing in rendered docs
2 participants