search

berkeley-dsep-infra / hubploy

Toolkit to deploy many z2jh based JupyterHubs
BSD 3-Clause "New" or "Revised" License
17 stars 15 forks source link

Documentation Updates #78

Closed salvis2 closed 4 years ago

salvis2 commented 4 years ago

Setting up structures for documentation updates. Hopefully I will offer initial looks at every how-to and topic listed in this initial commit. Looking to work more on this in the coming week. @yuvipanda what is your procedure for testing sphinx? And how do you deploy the documentation?

salvis2 commented 4 years ago

So I am running sphinx-build -b html . built-docs to test the documentation. Only warning I get right now is 

WARNING: html_static_path entry '_static' does not exist

So I'm fairly confident that these are looking good syntax-wise. Still more docs to come.

@yuvipanda, I've noticed that you manually line break your .rst files; is this to prevent large diffs in git? Should I also do this?

yuvipanda commented 4 years ago

@salvis2 this is awesome!

Yes, I manually line break my .rst files for diffs. Would love if you could do that too! I think my editor has helpers for it as well.

Let's merge this right after!

salvis2 commented 4 years ago

Okay, I'll look at line breaks in the morning and try to make it my next commit. Do you have a character limit set for that?

salvis2 commented 4 years ago

I've realized I don't actually know a lot about the image building (I know what command to run, but that's about it), so I was going to leave docs/howto/hubploy-build-jupyterhub-image.rst for someone else to fill in. The file is linked in docs/howto/index.rst at the moment, but if you want it unlinked until there is content, that is an easy change.

yuvipanda commented 4 years ago

Thanks for working on this, @salvis2! \o/