Skip to content

Initial documentation for SSL support #7

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

Closed
wants to merge 1 commit into from

Conversation

jellevdd
Copy link

I haven't worked with Sphinx yet, I've edited the source but don't really know how to build the html pages from it.

@jellevdd
Copy link
Author

@deanberris Could you review/help me build the HTML? Thanks!

@deanberris
Copy link
Member

Thanks @jellevdd -- it's actually not that hard to install Sphinx (if you're running on Mac/Linux). I'm not familiar with how to do it on Windows.

Also, you may need to change the .rst files that are used to generate the .txt and .html files. Once you've installed Sphinx (via Python's pip installer last I checked), you can create the documentation by running 'make' in the libs/network/doc/ directory.

I see that you're trying to make the change directly to the website, but unfortunately the process we follow with this is by making changes to the development branch, and when the release is packaged we also update this website with the sources generated from the libs/network/doc/html/ directory. That keeps us consistent across releases.

Let me know if you need more information, feel free to reach out via email. I'll close this pull request, and then look forward to the next one to cpp-netlib's packaged documentation.

Cheers

@deanberris deanberris closed this May 21, 2014
@jellevdd jellevdd deleted the master-integration branch May 21, 2014 06:51
@jellevdd
Copy link
Author

@deanberris Thanks for the help, I've created a new pull request for the 0.11.0 devel branch containing the initial documentation (see cpp-netlib/cpp-netlib#398). Could you take a look?
Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants