Skip to content
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

Reorganize API docs into subpages (backport #927) #940

Closed
wants to merge 1 commit into from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jul 24, 2023

This is an automatic backport of pull request #927 done by Mergify.
Cherry-pick of bca9271 has failed:

On branch mergify/bp/stable/0.13/pr-927
Your branch is up to date with 'origin/stable/0.13'.

You are currently cherry-picking commit bca9271.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   docs/source/api/algorithm_functions/centrality.rst
	new file:   docs/source/api/algorithm_functions/connectivity_and_cycles.rst
	new file:   docs/source/api/algorithm_functions/dag_algorithms.rst
	new file:   docs/source/api/algorithm_functions/graph_operations.rst
	new file:   docs/source/api/algorithm_functions/index.rst
	new file:   docs/source/api/algorithm_functions/isomorphism.rst
	new file:   docs/source/api/algorithm_functions/link_analysis.rst
	new file:   docs/source/api/algorithm_functions/matching.rst
	new file:   docs/source/api/algorithm_functions/other.rst
	new file:   docs/source/api/algorithm_functions/shortest_paths.rst
	new file:   docs/source/api/algorithm_functions/traversal.rst
	new file:   docs/source/api/algorithm_functions/tree.rst
	new file:   docs/source/api/converters.rst
	new file:   docs/source/api/custom_return_types.rst
	new file:   docs/source/api/exceptions.rst
	new file:   docs/source/api/generators.rst
	new file:   docs/source/api/graph_classes.rst
	new file:   docs/source/api/index.rst
	new file:   docs/source/api/layout_functions.rst
	new file:   docs/source/api/pydigraph_api_functions.rst
	new file:   docs/source/api/pygraph_api_functions.rst
	new file:   docs/source/api/random_graph_generator_functions.rst
	new file:   docs/source/api/serialization.rst
	modified:   docs/source/index.rst
	modified:   docs/source/install.rst

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by them: docs/source/api.rst

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally


Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

  • @Mergifyio refresh will re-evaluate the rules
  • @Mergifyio rebase will rebase this PR on its base branch
  • @Mergifyio update will merge the base branch into this PR
  • @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

  • look at your merge queues
  • generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com

* Reorganize API docs into subfolders

* Increase maxdepth for functions page

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit bca9271)

# Conflicts:
#	docs/source/api.rst
@mergify mergify bot added the conflicts label Jul 24, 2023
@coveralls
Copy link

Pull Request Test Coverage Report for Build 5649602085

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 96.383%

Totals Coverage Status
Change from base Build 5605320059: 0.0%
Covered Lines: 15004
Relevant Lines: 15567

💛 - Coveralls

@mtreinish mtreinish mentioned this pull request Jul 25, 2023
2 tasks
@Eric-Arellano
Copy link
Contributor

Replaced by #940

@mtreinish mtreinish closed this Jul 25, 2023
@mtreinish mtreinish deleted the mergify/bp/stable/0.13/pr-927 branch July 25, 2023 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants