Crate docs for apis module

[josecelano]

Documentation for the crate::servers::apis module.

[da2ce7]

Why the changing from rust,ignore to text?

[josecelano]

I do not want to compile that piece of code, and I do not want to have an "ignore" test in the output like this:

& cargo test --doc
test src/tracker/mod.rs - tracker (line 83) - compile ... ignore

Sometimes the necessary setup to compile is too verbose for the documentation. For example:

let announce_data = tracker.announce(&info_hash, &mut peer, &peer_ip).await;

That line would require building a tracker, a peer, etc.

We have the tests if you want to check a fully operational example; maybe I could add a link to the tests in these cases.

I can also implement the full working example and hide the lines that are not interesting for the documentation.

[josecelano]

The link to how to hide code in docs is wrong. I've read somewhere else that you can do that, but I do not find it.

[josecelano]

The link was not wrong it's only that you need to prepend the hashtag to all the lines you want to hide:

//! ```rust,no_run
//! # use torrust_tracker::tracker::peer;
//! # use torrust_tracker::shared::bit_torrent::info_hash::InfoHash;
//! # // ...
//! 
//! let announce_data = tracker.announce(&info_hash, &mut peer, &peer_ip).await;
//! ```

That would show only:

let announce_data = tracker.announce(&info_hash, &mut peer, &peer_ip).await;

[josecelano]

Hey, @da2ce7 @WarmBeer, I'm not going to include in the API docs information about how to set up Nginx or Apache as reverse proxies, with or without SSL. I think we can move that information to blog posts (tutorials) on the torrust.com site.

[josecelano]

ACK 81c4d70

[josecelano]

Hi @da2ce7 @WarmBeer, this is ready to review.