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

More Complete Info about Auto Documentation #934

Open
s2t2 opened this issue May 23, 2024 · 1 comment
Open

More Complete Info about Auto Documentation #934

s2t2 opened this issue May 23, 2024 · 1 comment

Comments

@s2t2
Copy link

s2t2 commented May 23, 2024

The docs mention using either autodoc or autodoc2 to automatically generate documentation.

However the information provided is insufficient to reproduce.

Let's consider adding much more details to this page sufficient to help someone get it working, and/or add some references to a few working examples.

@i2000s
Copy link

i2000s commented May 30, 2024

In sphinx, we usually add a few lines to let the program know where to look up for autodoc sources. For instance, these

sys.path.insert(0, os.path.abspath(os.path.join('src')))
sys.path.insert(0, os.path.abspath(os.path.join('.')))
sys.path.insert(0, os.path.abspath(os.path.join('modules', 'my_module', 'src')))

But there doesn't seem to have a proper place to put these lines in Jupyter Book. Could MYSt-Parser to implement some machenism to recognize such settings in a markdown environment?

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

No branches or pull requests

2 participants