docs: fix documentation rendering

[ycexiao]

What problem does this PR address?

Closes #62

What should the reviewer(s) do?

Please check the rendered documentation.

[ycexiao]

@sbillinge, it's ready for review.

[ycexiao]

There is only one folder devutils inside src/diffpy/srreal. But in diffpy.structure, this folder is not in the src folder. Do we want to build an API page for this package?

[sbillinge]

I changed the base to migration just in case.

Srreal code is mostly c-code so it may not build very rich API docs. @Tieqiong do you know a way to build API docs from c-code drilling down through python wrappers?

[sbillinge]

@ycexiao @zmx27 at the least we would like the docs to have as much informatoin as in the original docs if we can find a link to them. There are some simple docstrings in the python wrappers. I didn't check the c code to see if there are any docstring like things in there.

[sbillinge]

here is the link to the original docs: https://pyobjcryst.readthedocs.io/en/latest/

[sbillinge]

We can have a conversation with Vincent about what style to use (conform to diffpy standards or to pyobj legacy) but it would be nice if we could figure it out for the docs to build and deploy automatically using our workflows. We may need to sort out whether it will finally deploy to readthedocs or gh-pages.

[sbillinge]

We can have a conversation with Vincent about what style to use (conform to diffpy standards or to pyobj legacy) but it would be nice if we could figure it out for the docs to build and deploy automatically using our workflows. We may need to sort out whether it will finally deploy to readthedocs or gh-pages.

sorry, this refers to pyobjcryst not srreal

[sbillinge]

I will merge this. Please could we make an issue (and work on) the devutils issue. I would like to understand what it does and how to handle it. Not a big job, just 30 minutes of digging around.

[Tieqiong]

I changed the base to migration just in case.

Srreal code is mostly c-code so it may not build very rich API docs. @Tieqiong do you know a way to build API docs from c-code drilling down through python wrappers?

@sbillinge sorry missed this. Yes! and let's have this conversation at pyobjcryst.