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

Monitor source files that may contain documentation update #3

Open
mertzjames opened this issue Jun 2, 2016 · 6 comments
Open

Monitor source files that may contain documentation update #3

mertzjames opened this issue Jun 2, 2016 · 6 comments

Comments

@mertzjames
Copy link

When running sphinxserve it'd be nice to have the ability to update documentation within the source code and that update within sphinxserve.

@mzdaniel
Copy link
Owner

mzdaniel commented Jun 2, 2016

Certainly would be. The issue is that modules can be loader from anywhere in the python sys.path. watchdog only looks in the directory (and subdirectories) where the conf.py lives.

@mertzjames
Copy link
Author

perhaps you can monitor the same paths that are appended within the conf.py?

@mertzjames
Copy link
Author

Or is there a way to monitor the files that are specified within the conf.py and other associated doc files. For example:

.. automodule:: <file>
   :members:

Couldn't you extract the from there?

@mzdaniel
Copy link
Owner

mzdaniel commented Jun 3, 2016

There is an open issue sphinx-doc/sphinx#1031 similar to this one.
Python modules usually have dependencies that don't live in the same path.
Did you try using PYTHONPATH?

@mertzjames
Copy link
Author

This is more for you server rather than sphinx. What I'm saying is that somehow your server could monitor source files that are called out in the doc files so that we their documentation changes, it would automatically update as well.

@mzdaniel
Copy link
Owner

I understand that and would be great to implement something that monitor modules too. If you can think in a simple solution for this issue, PR's are welcome! One idea could be to add a cli switch specifying paths to look for modules? What do you think?

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