Skip to content

Sphinx support (WIP) #74

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

Open
wants to merge 45 commits into
base: main
Choose a base branch
from

Conversation

ClimenteA
Copy link

@ClimenteA ClimenteA commented Mar 26, 2024

Given path to sphinx docs it will generate for each xml file found in build folder a standalone html file.

TODO

  • integrate with ejs template;
  • there are some edge cases where xml is not parsed corectly (2 or more level nested lists, bad xml with no start/closing tags - these are the ones I know);
  • tests

Checkout Sphinx documentation section in readme to see how it works.

I attached the zip with html files generated after postdoc init command.
docs-generated.zip

@ClimenteA
Copy link
Author

Also, here are the generated xml files after sphinx-build xml command which can be used for tests:
sphinx-docs.zip

Path to these docs will be required if sphinx-docs template is selected on postdoc init.

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.

1 participant