testing rtd suds documentation

[emezeta]

just a first approach https://suds-example.readthedocs.io/en/master/

[phillbaker]

It looks like there's also https://suds.readthedocs.io/en/master/, which has as a source https://github.com/emezeta/suds_sphinx/blob/master/docs/source/index.rst.

I'd vote to use the suds.readthedocs.io subdomain. Do you mind adding me as a admin?

[phillbaker]

Would you like to do a PR to this repo for https://github.com/emezeta/suds-doc-test/commit/af60f3d954085e89287677f941935cfd67d08170 ?

• I don't think we want the _build directory, so that should be added to .gitignore

Related to https://github.com/suds-community/suds/issues/5

[emezeta]

It looks like there's also https://suds.readthedocs.io/en/master/, which has as a source https://github.com/emezeta/suds_sphinx/blob/master/docs/source/index.rst.

I'd vote to use the suds.readthedocs.io subdomain. Do you mind adding me as a admin?

The way I know for keeping the documentation in sync with source code is by linking it to repos. In order not to break anything in suds-community repos while I was doing some trial and practice, what I did was fork it. Then I linked the documentation to the said fork.

Hence we have an interesting variety of repos, RTD entries... The point here is in the weakness of "the way I know". Anyway, I have now created a new organization, suds-documentation to which I transferred the doc-sphinx repo. I made @phillbaker owner here.

Off course, https://readthedocs.org/projects/suds/ would be the manager RTD suds site, and https://suds.readthedocs.io the url for compiled's versions.

If you pass me a username on RTD I can also make you an owner there.

[phillbaker]

I'm phillbaker on RTD. I don't think there's a need for separate organizations - happy to make you an admin of that repo on this org! And potentially I think we could keep the docs generation in this repo.

[emezeta]

I agree. I'll drop things I've done before, just to keep the house clean. I'll also point out the main repo as the new source of RTD. Then we'll see how we continue, if a new repository for documentation or what, within the suds community, synchronization policies to follow and so on...

[adab4d]

I am trying to figure out the status of the docs, AFAICS

• https://rtfd.io/projects/suds-example has been deleted
• https://readthedocs.org/projects/suds/ does exist and lists https://github.com/emezeta/suds_sphinx.git as repository
• https://github.com/emezeta/suds_sphinx.git redirects to https://github.com/suds-documentation/documentation
• https://suds.readthedocs.io/ should present the compiled docs but is empty of content at the moment

So the rtfd project should be updated to point to suds-community/suds and a new build should be triggered in order to produce actual content, is that right?

[emezeta]

As far as I understand, it would be enough by creating the new location in the main repository, perhaps at https://github.com/suds-community/doc

That way the final shape should be https://github.com/suds-community/suds/doc https://suds.readthedocs.io/ All other is left over

[emezeta]

I just pointed https://readthedocs.org/projects/suds/ to ~https://github.com/suds-community/suds/doc~ https://github.com/suds-community/documentation which of course does not exist yet, hence the fail what shows now at RTH.

Now someone with enough permissions should accept the move https://github.com/suds-documentation/documentation to ~https://github.com/suds-community/doc~ https://github.com/suds-community/documentation I can do the pull request and that's it.

[phillbaker]

@emezeta I've created https://github.com/suds-community/doc and given you permissions on it

[phillbaker]

I've transferred https://github.com/suds-documentation/documentation to https://github.com/suds-community/documentation and updated https://readthedocs.org/dashboard/suds/edit/, the build succeeded (https://readthedocs.org/projects/suds/builds/12051698/), but I'm not seeing the documentation at https://suds.readthedocs.io/en/latest/.

[anddam]

I've created https://github.com/suds-community/doc

Is that private? I am getting a 404 there.

[emezeta]

I think it is actually https://github.com/suds-community/documentation

[emezeta]

Again, we have suds rtd pointing to emezeta/suds fork as a demo. The fork is an exact copy of suds-community/suds with the addition of the docs folder. At the same time, docs is an exact copy of suds-community/documentation/docs.

In suds-community/documentation/Readme.rst I left two guide lines to install the documentation in local copy.

To avoid this bother, it should be enough to move suds-community/documentation/docs folder to the root of the repository so it look like this:

We also need to create a Webhook on github repo to bind RTD site. With the proper permissions go to Settings->Webhook and set like this:

Payloads:: https://readthedocs.org/api/v2/webhook/suds/51060/

Content type:: applicattion/json

leave other values as they are.

This would keep the documentation synchronized with the repository, reflecting each change as it occurs

[emezeta]

I changed .md to .rst in README file because I couldn't get GH to recognize .md code syntax highlighting

https://github.com/emezeta/suds/blob/master/README.rst Like it! ;)

[phillbaker]

Cherry picked these commits onto master. Deleted suds-community/documentation. Docs are building. There's some additional work that should be done to finish the conversion from epydocs to spinx, right now it's being done at build time.