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

docs to literate #77

Merged
merged 9 commits into from
Mar 22, 2020
Merged

Conversation

mattuntergassmair
Copy link
Collaborator

Documentation tutorials from markdown format to Literate format (allows including and testing and conversion to markdown&notebooks)

@mattuntergassmair
Copy link
Collaborator Author

work in progress, needs a few more fixes (will take care of it tomorrow)

@coveralls
Copy link

coveralls commented Mar 18, 2020

Coverage Status

Coverage decreased (-0.02%) to 80.589% when pulling 7efb076 on mattuntergassmair:docs_to_literate into 52740c5 on sisl:master.

@MaximeBouton
Copy link
Member

Something to be aware of, if we add AutoViz in the testing dependencies we will have a cycle!

@mattuntergassmair
Copy link
Collaborator Author

mattuntergassmair commented Mar 19, 2020

Something to be aware of, if we add AutoViz in the testing dependencies we will have a cycle!

That's correct, but since it is an extra dependency that's used for tests only I wouldn't think that's a problem, right? The only alternatives are 1. not running the tutorials as part of the test suite or 2. not doing any visualization in the tutorials, but I guess none of those options is desireable.

Do you think it would be better (in this context, and in general), to have a separate Project.toml for tests (i.e. tests/Project.toml just like for docs) rather than having it in the [extras] section? I am a bit confused about the best practices with regards to this

@MaximeBouton MaximeBouton mentioned this pull request Mar 20, 2020
17 tasks
@MaximeBouton
Copy link
Member

There is quite a lot going on on master and incorporate_rec. I would say we finish the work there, and fix the tutorials here + merge after?

@MaximeBouton MaximeBouton merged commit 1483ca3 into sisl:master Mar 22, 2020
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.

None yet

3 participants