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

make scripts dir as a module, to be included by find_packages() of setuptools #215

Merged
merged 1 commit into from
Jun 9, 2019

Conversation

thammegowda
Copy link
Contributor

Closes #210

@choldgraf
Copy link
Member

I'll merge this and push a new minor version of jupyterbook, then can you check if it works on your end as expected?

@choldgraf choldgraf merged commit 475a90f into executablebooks:master Jun 9, 2019
@thammegowda
Copy link
Contributor Author

@choldgraf
I had already tested (with local installation)

  • by removing the pip installed remote package
  • reinstalling locally pip install . from the root of this repo (after the fix)

it updated the toc. I dont think it would be any different than remote pip install. I can test it again if needed.

Feedback: the toc generated by generate_toc.py was not usable for me.
Mainly, it didn't preserve the subsections and order (which are a must-have for me).
For now, I am hand creating the toc (since I can define order and subsections the way I want).

I dont know if you are planning, here are some suggestions for future enhancements :

  1. Deterministic sorting (alphanumeric should be okay) to preserve the order
  2. sub-directories maybe be treated as sub-sections
  3. Before overwriting, take backup of tac file, or update the yaml preserving much of metadata: numbered or not etc.

@choldgraf
Copy link
Member

choldgraf commented Jun 9, 2019

@thammegowda totally agree - the TOC script can definitely be improved. Wanna create an issue for this enhancement so we can track it? I think some of those things will actually be tricky (you'd need to encode the proper ordering of the TOC in the naming of the folders and/or sub-folders) but it's worth improving. Initially the TOC was just meant to be a quick helper for people to get started, with the idea that they'd manually update the TOC after this. But if there's a way to improve its functionality without making it super complicated, I'm for it

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.

Double check that generate_toc.py is getting copied properly
2 participants